{ "components": { "schemas": { "A01_Response_200": { "type": "object", "properties": { "applicable_taxes": { "type": "array", "description": "List of the shop's applicable taxes", "items": { "$ref": "#/components/schemas/A01_Response_200_ApplicableTaxes" } }, "approval_delay": { "type": "integer", "format": "int64", "description": "Average time for a shop to accept or refuse an order (in seconds)" }, "approval_rate": { "type": "number", "format": "with decimals", "description": "Rate of accepted orders" }, "banner": { "type": "string", "description": "Url of the shop's banner image" }, "billing_info": { "$ref": "#/components/schemas/A01_Response_200_BillingInfo", "deprecated": true, "description": "

Banking information

Use “payment_info” attribute instead

" }, "channels": { "type": "array", "description": "List of the channel codes associated to the shop", "items": { "type": "string" }, "uniqueItems": true }, "closed_from": { "type": "string", "format": "date-time", "description": "The start date of the closing of the shop" }, "closed_to": { "type": "string", "format": "date-time", "description": "The end date of the closing of the shop" }, "contact_informations": { "$ref": "#/components/schemas/A01_Response_200_ContactInformations", "description": "Contact information" }, "currency_iso_code": { "type": "string", "description": "The currency of the shop (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date_created": { "type": "string", "format": "date-time", "description": "Creation date of the shop" }, "default_billing_information": { "$ref": "#/components/schemas/A01_Response_200_DefaultBillingInformation", "description": "The default billing information of the shop, used for invoicing and reporting purposes" }, "description": { "type": "string", "description": "The description of the shop, max length: 3000 characters." }, "domains": { "type": "array", "description": "Shop domains", "items": { "type": "string", "description": "Enum: `\"PRODUCT\"`, `\"SERVICE\"`\n" }, "uniqueItems": true }, "dropship": { "$ref": "#/components/schemas/A01_Response_200_Dropship", "description": "Dropship configuration" }, "evaluations_count": { "type": "integer", "format": "int64", "description": "Number of evaluations for the shop" }, "free_shipping": { "type": "boolean", "description": "Whether or not this shop offers free shipping to customers" }, "grade": { "type": "number", "format": "with decimals", "description": "Global grade of the shop" }, "is_professional": { "type": "boolean", "description": "Whether or not the shop is professional" }, "kyc": { "$ref": "#/components/schemas/A01_Response_200_Kyc", "description": "KYC information (only supported when KYC feature is enabled)" }, "last_updated_date": { "type": "string", "format": "date-time", "description": "The date of the last modification of the shop.\nNote: The following statistics fields do not update the last_updated date:\n\n" }, "logo": { "type": "string", "description": "Url of the shop's logo image" }, "model": { "type": "string", "description": "Shop platform model, current possible values :\n\n\nEnum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n" }, "offers_count": { "type": "integer", "format": "int64", "description": "Total count of active offers of the shop" }, "order_messages_response_delay": { "type": "integer", "format": "int64", "description": "Average time for a shop to answer to an order message (in seconds)" }, "orders_count": { "type": "integer", "format": "int64", "description": "Total count of debited orders (or if Pay on Delivery, accepted) of the shop" }, "payment_details": { "$ref": "#/components/schemas/A01_Response_200_PaymentDetails", "description": "Payment details" }, "payment_info": { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo", "description": "Payment information" }, "payment_method_mandatory": { "type": "boolean", "description": "Payment method mandatory" }, "premium": { "type": "boolean", "description": "Whether or not the shop is premium" }, "pro_details": { "$ref": "#/components/schemas/A01_Response_200_ProDetails", "deprecated": true, "description": "

Professional details

Use \"default_billing_information\" instead

" }, "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/A01_Response_200_ProducerIdentifiers" }, "uniqueItems": true }, "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": "Terms of restitution, max length: 60000 characters." }, "shipping": { "$ref": "#/components/schemas/A01_Response_200_Shipping", "description": "Shop shipping configuration" }, "shipping_country": { "type": "string", "description": "Code ISO 3166-1 alpha-3 of the shipping country" }, "shipping_types": { "type": "array", "deprecated": true, "description": "

List of shipping types of the shop

Use “shippings” attributes instead

", "items": { "type": "string", "deprecated": true } }, "shipping_zones": { "type": "array", "deprecated": true, "description": "

List of shipping zones of the shop

Use “shippings” attributes instead

", "items": { "type": "string", "deprecated": true } }, "shippings": { "type": "array", "description": "All the pair shipping zone / shipping type accepted by the shop", "items": { "$ref": "#/components/schemas/A01_Response_200_Shippings" } }, "shop_additional_fields": { "type": "array", "description": "List of additional fields", "items": { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } }, "shop_id": { "type": "integer", "format": "int64", "description": "The identifier of the shop" }, "shop_name": { "type": "string", "description": "The name of the shop" }, "shop_state": { "type": "string", "description": "The state of the shop\n\nEnum: `\"OPEN\"`, `\"CLOSE\"`, `\"SUSPENDED\"`, `\"TERMINATED\"`\n" }, "specific_billing_informations": { "type": "array", "description": "The list of specific billing information of the shop, used for invoicing and reporting purposes\n
Applies only when the shop is professional\n", "items": { "$ref": "#/components/schemas/A01_Response_200_SpecificBillingInformations" } }, "suspension_type": { "type": "string", "description": "Shop suspension type, current possible values:\n\nEnum: `\"MANUAL\"`, `\"PENDING_APPROVAL\"`, `\"INCOMPLETE_PROFILE\"`, `\"AUTOMATIC_SUSPENSION\"`\n" } }, "required": [ "billing_info", "channels", "contact_informations", "currency_iso_code", "date_created", "default_billing_information", "domains", "evaluations_count", "free_shipping", "is_professional", "last_updated_date", "offers_count", "orders_count", "payment_details", "payment_method_mandatory", "premium", "pro_details", "shipping", "shipping_types", "shipping_zones", "shop_additional_fields", "shop_id", "shop_name", "shop_state" ] }, "A01_Response_200_ApplicableTaxes": { "type": "object", "properties": { "code": { "type": "string", "description": "Tax code" }, "fee_types": { "type": "array", "description": "The types of fees to which the tax will be applied.", "items": { "type": "string", "description": "Enum: `\"COMMISSION\"`, `\"SUBSCRIPTION\"`, `\"ADDITIONAL_FEES\"`\n" } }, "label": { "type": "string", "description": "Tax label " } }, "required": [ "code", "label" ] }, "A01_Response_200_BillingInfo": { "type": "object", "deprecated": true, "properties": { "bank_city": { "type": "string", "description": "City of the bank" }, "bank_name": { "type": "string", "description": "Name of the bank" }, "bank_street": { "type": "string", "description": "Address of the bank" }, "bic": { "type": "string", "description": "BIC of the bank associated to the account" }, "iban": { "type": "string", "description": "IBAN of the bank account" }, "owner": { "type": "string", "description": "Name of the owner of the bank account" }, "zip_code": { "type": "string", "description": "Zip code of the bank" } } }, "A01_Response_200_ContactInformations": { "type": "object", "properties": { "city": { "type": "string", "description": "City of the contact" }, "civility": { "type": "string", "description": "Civility of the contact (Mr, Mrs, Miss or Neutral)" }, "country": { "type": "string", "description": "Code ISO 3166-1 alpha-3 of the contact's country" }, "email": { "type": "string", "description": "Email" }, "fax": { "type": "string", "description": "Fax, max length: 20 characters." }, "firstname": { "type": "string", "description": "First name of the contact" }, "lastname": { "type": "string", "description": "Last name of the contact" }, "phone": { "type": "string", "description": "Phone" }, "phone_secondary": { "type": "string", "description": "Secondary phone" }, "state": { "type": "string", "description": "State (address) of the contact" }, "street1": { "type": "string", "description": "First line of the address of the contact" }, "street2": { "type": "string", "description": "Second line of the address of the contact" }, "web_site": { "type": "string", "description": "Website of the shop" }, "zip_code": { "type": "string", "description": "Zip code of the contact" } }, "required": [ "city", "country", "email", "lastname", "street1" ] }, "A01_Response_200_DefaultBillingInformation": { "type": "object", "properties": { "corporate_information": { "$ref": "#/components/schemas/A01_Response_200_DefaultBillingInformation_CorporateInformation", "description": "The corporate information of the shop.\n
Applies only when the shop is professional\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.\n
Applies only when the shop is professional\n" }, "fiscal_representative": { "$ref": "#/components/schemas/A01_Response_200_DefaultBillingInformation_FiscalRepresentative", "description": "The fiscal representative associated to the billing information.\n
Applies only when the shop is professional\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.\n
Applies only when the shop is non professional or professional sole trader\n" }, "registration_address": { "$ref": "#/components/schemas/A01_Response_200_DefaultBillingInformation_RegistrationAddress", "description": "The complete registration address of the shop." } }, "required": [ "default_language", "id", "registration_address" ] }, "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.\n
Applies only when the operator is registered in the EU, and the seller is registered in France.\n" }, "company_registration_city": { "type": "string", "description": "The city of the company's registry office.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n" }, "is_in_liquidation": { "type": "boolean", "description": "Indicates whether the company is in liquidation or not.\n
Applies only when the operator is registered in the EU\n" }, "legal_form": { "type": "string", "description": "The legal form of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital": { "type": "number", "format": "with decimals", "description": "The share capital of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital_currency": { "type": "string", "description": "The share capital currency of the company.\n
Applies only when the operator is registered in the EU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\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\n\nEnum: `\"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\"`\n" }, "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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "civility", "company_registration_name", "company_registration_number", "country_iso_code", "first_name", "last_name", "street_1" ] }, "A01_Response_200_DefaultBillingInformation_PersonalInformation": { "type": "object", "properties": { "birth_city": { "type": "string", "description": "The city of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "birth_country": { "type": "string", "description": "The country of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n\n\nEnum: `\"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\"`\n" }, "birth_date": { "type": "string", "format": "date", "description": "The birth date of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "civility": { "type": "string", "description": "The civility of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "first_name": { "type": "string", "description": "The first name of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "last_name": { "type": "string", "description": "The last name of the shop owner.\n
Applies only when the shop is non 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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "country_iso_code", "street_1" ] }, "A01_Response_200_Dropship": { "type": "object", "properties": { "retail_pricing_edition_enabled": { "type": "boolean", "description": "Retail pricing edition enabled" } }, "required": [ "retail_pricing_edition_enabled" ] }, "A01_Response_200_Kyc": { "type": "object", "properties": { "reason": { "type": "string", "description": "KYC refusal reason" }, "status": { "type": "string", "description": "KYC status\n\nEnum: `\"PENDING_SUBMISSION\"`, `\"PENDING_APPROVAL\"`, `\"REFUSED\"`, `\"APPROVED\"`, `\"NOT_REQUIRED\"`\n" } }, "required": [ "status" ] }, "A01_Response_200_PaymentDetails": { "type": "object", "properties": { "paid_balance": { "type": "number", "format": "with decimals", "description": "Paid balance" }, "payable_balance": { "type": "number", "format": "with decimals", "description": "Payable balance" }, "pending_balance": { "type": "number", "format": "with decimals", "description": "Pending balance" }, "reserve_balance": { "type": "number", "format": "with decimals", "description": "Current reserve balance" }, "reserve_target": { "type": "number", "format": "with decimals", "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" } } }, "required": [ "paid_balance", "payable_balance", "pending_balance" ] }, "A01_Response_200_PaymentDetails_SubBalances": { "type": "object", "properties": { "paid": { "type": "number", "format": "with decimals", "description": "Paid balance" }, "pay_out_psp_code": { "type": "string", "description": "Code of the Payment Service Provider (PSP)\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" }, "payable": { "type": "number", "format": "with decimals", "description": "Payable balance" }, "pending": { "type": "number", "format": "with decimals", "description": "Pending balance" } }, "required": [ "paid", "pay_out_psp_code", "payable", "pending" ] }, "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", "description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n" }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 } }, "required": [ "owner" ] }, "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]+" } }, "required": [ "bank_account_number", "bank_name", "routing_number" ] }, "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 } }, "required": [ "auban", "aubsb", "bank_name" ] }, "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 type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "pattern": "[0-9]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "pattern": "[0-9]+" }, "pix_key": { "type": "string", "description": "Pix key", "maxLength": 255, "minLength": 0 } }, "required": [ "account_number", "bank_account_type", "bank_code", "bank_name", "branch_code" ] }, "A01_Response_200_PaymentInfo_Canadian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 12, "minLength": 5, "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 }, "institution_number": { "type": "string", "description": "Bank institution number", "pattern": "[0-9]+" }, "swift_code": { "type": "string", "description": "Bank account swift code" }, "transit_number": { "type": "string", "description": "Bank transit number", "pattern": "[0-9]+" } }, "required": [ "bank_account_number", "bank_name", "institution_number", "transit_number" ] }, "A01_Response_200_PaymentInfo_Colombian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 } }, "required": [ "account_number", "bank_account_type", "bank_name" ] }, "A01_Response_200_PaymentInfo_Guatemalan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 255, "minLength": 1, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 } }, "required": [ "account_number", "bank_account_type", "bank_name" ] }, "A01_Response_200_PaymentInfo_Hk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 12, "minLength": 9, "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 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "swift_code" ] }, "A01_Response_200_PaymentInfo_Iban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "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" }, "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "bank_name", "bic", "iban" ] }, "A01_Response_200_PaymentInfo_Indian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 20, "minLength": 6, "pattern": "[0-9a-zA-Z]+" }, "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 }, "indian_financial_system_code": { "type": "string", "description": "Indian financial system code" }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "account_number", "bank_name", "indian_financial_system_code" ] }, "A01_Response_200_PaymentInfo_Israeli": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 9, "minLength": 1, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "maxLength": 4, "minLength": 1, "pattern": "[0-9]+" }, "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 }, "branch_name": { "type": "string", "description": "Branch name" } }, "required": [ "bank_account_number", "bank_code", "bank_name" ] }, "A01_Response_200_PaymentInfo_Japanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 8, "minLength": 6 }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "pattern": "[0-9]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "pattern": "[0-9]+" }, "branch_name": { "type": "string", "description": "Branch name" }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_account_type", "bank_code", "bank_name", "branch_code", "branch_name" ] }, "A01_Response_200_PaymentInfo_Mexican": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 20, "minLength": 5, "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 }, "clabe": { "type": "string", "description": "Clave Bancaria Estandarizada" } }, "required": [ "bank_account_number", "bank_name", "clabe" ] }, "A01_Response_200_PaymentInfo_Nuban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "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 }, "nuban": { "type": "string", "description": "The bank account NUBAN code", "maxLength": 255, "minLength": 10 } }, "required": [ "bank_name", "nuban" ] }, "A01_Response_200_PaymentInfo_Nzbsb": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "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 }, "nzban": { "type": "string", "description": "Bank Account Number", "maxLength": 10, "minLength": 10 }, "nzbsb": { "type": "string", "description": "Bank State Branch code." } }, "required": [ "bank_name", "nzban", "nzbsb" ] }, "A01_Response_200_PaymentInfo_Payout": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number (required for LOCAL_UK and INTERNATIONAL formats)" }, "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 (required for INTERNATIONAL format)" }, "iban": { "type": "string", "description": "Bank account IBAN (required for LOCAL_IBAN format)" }, "payout_format": { "type": "string", "description": "Payout format type\n\nEnum: `\"LOCAL_IBAN\"`, `\"LOCAL_UK\"`, `\"INTERNATIONAL\"`\n" }, "sort_code": { "type": "string", "description": "Bank Sort Code (required for LOCAL_UK format)", "pattern": "[0-9]+" } }, "required": [ "bank_name", "payout_format" ] }, "A01_Response_200_PaymentInfo_Philippines": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 16, "minLength": 10, "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 } }, "required": [ "bank_account_number", "bank_name" ] }, "A01_Response_200_PaymentInfo_Serbian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "pattern": "[0-9]+" }, "bank_branch_number": { "type": "string", "description": "Bank branch number", "maxLength": 10, "minLength": 1 }, "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" }, "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "bank_account_number", "bank_branch_number", "bank_name" ] }, "A01_Response_200_PaymentInfo_Sg": { "type": "object", "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 12, "minLength": 9, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_key": { "type": "string", "description": "Bank Key", "pattern": "[0-9]+" }, "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 }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "owner", "swift_code" ] }, "A01_Response_200_PaymentInfo_Taiwanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 14, "minLength": 8, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "maxLength": 3, "minLength": 2, "pattern": "[0-9a-zA-Z]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "maxLength": 4, "minLength": 3, "pattern": "[0-9a-zA-Z]+" } }, "required": [ "account_number", "bank_code", "bank_name", "branch_code" ] }, "A01_Response_200_PaymentInfo_Thai": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 12, "minLength": 10, "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 } }, "required": [ "account_number", "bank_name" ] }, "A01_Response_200_PaymentInfo_Uk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 11, "minLength": 6, "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_sort_code": { "type": "string", "description": "Bank Sort Code (Size must be 6 digits)", "pattern": "[0-9]+" }, "bank_street": { "type": "string", "description": "Bank street name", "maxLength": 100, "minLength": 3 }, "bank_zip": { "type": "string", "description": "Bank zip code", "maxLength": 255, "minLength": 0 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "bank_sort_code" ] }, "A01_Response_200_PaymentInfo_Uruguayan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 20, "minLength": 5, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "maxLength": 10, "minLength": 1, "pattern": "[0-9]+" } }, "required": [ "account_number", "bank_account_type", "bank_name", "branch_code" ] }, "A01_Response_200_PaymentInfo_Vietnamese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 255, "minLength": 1, "pattern": "[0-9a-zA-Z]+" }, "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 }, "branch_name": { "type": "string", "description": "Branch name", "maxLength": 255, "minLength": 0, "pattern": "[0-9a-zA-Z]+" } }, "required": [ "bank_account_number", "bank_name" ] }, "A01_Response_200_ProDetails": { "type": "object", "deprecated": true, "properties": { "VAT_number": { "type": "string", "deprecated": true, "description": "

VAT Number (for taxes)

Use tax_identification_number instead

" }, "corporate_name": { "type": "string", "deprecated": true, "description": "

Corporate name

Use \"default_billing_information.company_registration_name\" attribute instead

" }, "identification_number": { "type": "string", "deprecated": true, "description": "

Identification number of the shop. For France it would be the SIRET

Use \"default_billing_information.company_registration_number\" attribute instead

" }, "tax_identification_number": { "type": "string", "deprecated": true, "description": "

Tax identification number

Use \"default_billing_information.tax_identification_number\" attribute instead if the operator's tax number country is one of the following: Caribbean Netherlands, Cuba, Curaçao, Djibouti, Eritrea, Guam, South Korea, Liberia, Malaysia, Myanmar,PuertoRico, Solomon Islands, Somalia, South Sudan, Timor-Leste, Tuvalu, United States, or Yemen. Use \"default_billing_information.local_tax_number\" attribute instead otherwise

" } } }, "A01_Response_200_ProducerIdentifiers": { "type": "object", "properties": { "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Shop producer identifier.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code", "producer_id" ] }, "A01_Response_200_Shipping": { "type": "object", "properties": { "lead_time_to_ship": { "type": "integer", "format": "int32", "description": "Default lead time to ship of the shop" } } }, "A01_Response_200_Shippings": { "type": "object", "properties": { "additional_fields": { "type": "array", "description": "List of custom shipping fields for this shipping zone and shipping method", "items": { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } }, "shipping_free_amount": { "type": "number", "format": "with decimals", "description": "Minimal amount for free shipping" }, "shipping_type_code": { "type": "string", "description": "The code of the shipping type" }, "shipping_type_label": { "type": "string", "description": "The label of the shipping type" }, "shipping_type_standard_code": { "type": "string", "description": "The code of the standard shipping type" }, "shipping_zone_code": { "type": "string", "description": "The code of the shipping zone" }, "shipping_zone_label": { "type": "string", "description": "The label of the shipping zone" } }, "required": [ "shipping_type_code", "shipping_type_label", "shipping_zone_code", "shipping_zone_label" ] }, "A01_Response_200_Shippings_AdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_Boolean", "DATE": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_Date", "LINK": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_Link", "LIST": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_Numeric", "REGEX": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_Regex", "STRING": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_String", "TEXTAREA": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "A01_Response_200_Shippings_AdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_Shippings_AdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_Shippings_AdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/A01_Response_200_ShopAdditionalFields_Boolean", "DATE": "#/components/schemas/A01_Response_200_ShopAdditionalFields_Date", "LINK": "#/components/schemas/A01_Response_200_ShopAdditionalFields_Link", "LIST": "#/components/schemas/A01_Response_200_ShopAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/A01_Response_200_ShopAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/A01_Response_200_ShopAdditionalFields_Numeric", "REGEX": "#/components/schemas/A01_Response_200_ShopAdditionalFields_Regex", "STRING": "#/components/schemas/A01_Response_200_ShopAdditionalFields_String", "TEXTAREA": "#/components/schemas/A01_Response_200_ShopAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "A01_Response_200_ShopAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_ShopAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A01_Response_200_ShopAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A01_Response_200_SpecificBillingInformations": { "type": "object", "properties": { "corporate_information": { "$ref": "#/components/schemas/A01_Response_200_SpecificBillingInformations_CorporateInformation", "description": "The corporate information of the shop.\n
Applies only when the shop is professional\n" }, "fiscal_information": { "$ref": "#/components/schemas/A01_Response_200_SpecificBillingInformations_FiscalInformation", "description": "The fiscal information of the shop.\n
Applies only when the shop is professional\n" }, "fiscal_representative": { "$ref": "#/components/schemas/A01_Response_200_SpecificBillingInformations_FiscalRepresentative", "description": "The fiscal representative associated to the billing information.\n
Applies only when the shop is professional\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.\n
Applies only when the shop is non professional or professional sole trader\n" }, "registration_address": { "$ref": "#/components/schemas/A01_Response_200_SpecificBillingInformations_RegistrationAddress", "description": "The complete registration address of the shop." } }, "required": [ "id", "registration_address" ] }, "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.\n
Applies only when the operator is registered in the EU, and the seller is registered in France.\n" }, "company_registration_city": { "type": "string", "description": "The city of the company's registry office.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n" }, "is_in_liquidation": { "type": "boolean", "description": "Indicates whether the company is in liquidation or not.\n
Applies only when the operator is registered in the EU\n" }, "legal_form": { "type": "string", "description": "The legal form of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital": { "type": "number", "format": "with decimals", "description": "The share capital of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital_currency": { "type": "string", "description": "The share capital currency of the company.\n
Applies only when the operator is registered in the EU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\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\n\nEnum: `\"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\"`\n" }, "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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "civility", "company_registration_name", "company_registration_number", "country_iso_code", "first_name", "last_name", "street_1" ] }, "A01_Response_200_SpecificBillingInformations_PersonalInformation": { "type": "object", "properties": { "birth_city": { "type": "string", "description": "The city of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "birth_country": { "type": "string", "description": "The country of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n\n\nEnum: `\"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\"`\n" }, "birth_date": { "type": "string", "format": "date", "description": "The birth date of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "civility": { "type": "string", "description": "The civility of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "first_name": { "type": "string", "description": "The first name of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "last_name": { "type": "string", "description": "The last name of the shop owner.\n
Applies only when the shop is non 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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "country_iso_code", "street_1" ] }, "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.\n\nEnum: `\"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\"`\n" }, "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.\n\nEnum: `\"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\"`\n" }, "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", "description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n" }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 } }, "required": [ "owner" ] }, "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]+" } }, "required": [ "bank_account_number", "bank_name", "routing_number" ] }, "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 } }, "required": [ "auban", "aubsb", "bank_name" ] }, "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 type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "pattern": "[0-9]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "pattern": "[0-9]+" }, "pix_key": { "type": "string", "description": "Pix key", "maxLength": 255, "minLength": 0 } }, "required": [ "account_number", "bank_account_type", "bank_code", "bank_name", "branch_code" ] }, "A02_Request_PaymentInfo_Canadian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 12, "minLength": 5, "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 }, "institution_number": { "type": "string", "description": "Bank institution number", "pattern": "[0-9]+" }, "swift_code": { "type": "string", "description": "Bank account swift code" }, "transit_number": { "type": "string", "description": "Bank transit number", "pattern": "[0-9]+" } }, "required": [ "bank_account_number", "bank_name", "institution_number", "transit_number" ] }, "A02_Request_PaymentInfo_Colombian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 } }, "required": [ "account_number", "bank_account_type", "bank_name" ] }, "A02_Request_PaymentInfo_Guatemalan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 255, "minLength": 1, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 } }, "required": [ "account_number", "bank_account_type", "bank_name" ] }, "A02_Request_PaymentInfo_Hk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 12, "minLength": 9, "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 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "swift_code" ] }, "A02_Request_PaymentInfo_Iban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "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" }, "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "bank_name", "bic", "iban" ] }, "A02_Request_PaymentInfo_Indian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 20, "minLength": 6, "pattern": "[0-9a-zA-Z]+" }, "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 }, "indian_financial_system_code": { "type": "string", "description": "Indian financial system code" }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "account_number", "bank_name", "indian_financial_system_code" ] }, "A02_Request_PaymentInfo_Israeli": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 9, "minLength": 1, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "maxLength": 4, "minLength": 1, "pattern": "[0-9]+" }, "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 }, "branch_name": { "type": "string", "description": "Branch name" } }, "required": [ "bank_account_number", "bank_code", "bank_name" ] }, "A02_Request_PaymentInfo_Japanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 8, "minLength": 6 }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "pattern": "[0-9]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "pattern": "[0-9]+" }, "branch_name": { "type": "string", "description": "Branch name" }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_account_type", "bank_code", "bank_name", "branch_code", "branch_name" ] }, "A02_Request_PaymentInfo_Mexican": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 20, "minLength": 5, "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 }, "clabe": { "type": "string", "description": "Clave Bancaria Estandarizada" } }, "required": [ "bank_account_number", "bank_name", "clabe" ] }, "A02_Request_PaymentInfo_Nuban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "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 }, "nuban": { "type": "string", "description": "The bank account NUBAN code", "maxLength": 255, "minLength": 10 } }, "required": [ "bank_name", "nuban" ] }, "A02_Request_PaymentInfo_Nzbsb": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "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 }, "nzban": { "type": "string", "description": "Bank Account Number", "maxLength": 10, "minLength": 10 }, "nzbsb": { "type": "string", "description": "Bank State Branch code." } }, "required": [ "bank_name", "nzban", "nzbsb" ] }, "A02_Request_PaymentInfo_Payout": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number (required for LOCAL_UK and INTERNATIONAL formats)" }, "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 (required for INTERNATIONAL format)" }, "iban": { "type": "string", "description": "Bank account IBAN (required for LOCAL_IBAN format)" }, "payout_format": { "type": "string", "description": "Payout format type\n\nEnum: `\"LOCAL_IBAN\"`, `\"LOCAL_UK\"`, `\"INTERNATIONAL\"`\n" }, "sort_code": { "type": "string", "description": "Bank Sort Code (required for LOCAL_UK format)", "pattern": "[0-9]+" } }, "required": [ "bank_name", "payout_format" ] }, "A02_Request_PaymentInfo_Philippines": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 16, "minLength": 10, "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 } }, "required": [ "bank_account_number", "bank_name" ] }, "A02_Request_PaymentInfo_Serbian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "pattern": "[0-9]+" }, "bank_branch_number": { "type": "string", "description": "Bank branch number", "maxLength": 10, "minLength": 1 }, "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" }, "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "bank_account_number", "bank_branch_number", "bank_name" ] }, "A02_Request_PaymentInfo_Sg": { "type": "object", "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 12, "minLength": 9, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_key": { "type": "string", "description": "Bank Key", "pattern": "[0-9]+" }, "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 }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "owner", "swift_code" ] }, "A02_Request_PaymentInfo_Taiwanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 14, "minLength": 8, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "maxLength": 3, "minLength": 2, "pattern": "[0-9a-zA-Z]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "maxLength": 4, "minLength": 3, "pattern": "[0-9a-zA-Z]+" } }, "required": [ "account_number", "bank_code", "bank_name", "branch_code" ] }, "A02_Request_PaymentInfo_Thai": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 12, "minLength": 10, "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 } }, "required": [ "account_number", "bank_name" ] }, "A02_Request_PaymentInfo_Uk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 11, "minLength": 6, "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_sort_code": { "type": "string", "description": "Bank Sort Code (Size must be 6 digits)", "pattern": "[0-9]+" }, "bank_street": { "type": "string", "description": "Bank street name", "maxLength": 100, "minLength": 3 }, "bank_zip": { "type": "string", "description": "Bank zip code", "maxLength": 255, "minLength": 0 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "bank_sort_code" ] }, "A02_Request_PaymentInfo_Uruguayan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 20, "minLength": 5, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "maxLength": 10, "minLength": 1, "pattern": "[0-9]+" } }, "required": [ "account_number", "bank_account_type", "bank_name", "branch_code" ] }, "A02_Request_PaymentInfo_Vietnamese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 255, "minLength": 1, "pattern": "[0-9a-zA-Z]+" }, "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 }, "branch_name": { "type": "string", "description": "Branch name", "maxLength": 255, "minLength": 0, "pattern": "[0-9a-zA-Z]+" } }, "required": [ "bank_account_number", "bank_name" ] }, "A02_Request_ProDetails": { "type": "object", "description": "Professional details of the shop. Updated and not nullable if shop is declared as professional.", "properties": { "corporate_name": { "type": "string", "description": "Corporate name of the shop. Not nullable." }, "identification_number": { "type": "string", "description": "Identification number of the shop. For France it would be the SIRET. Only nullable if the country_iso_code corresponds to USA." }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the shop. Nullable." } } }, "A02_Request_ProducerIdentifiers": { "type": "object", "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.", "properties": { "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Shop producer identifier.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code", "producer_id" ] }, "A02_Request_ShopAdditionalFields": { "type": "object", "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.", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/A02_Request_ShopAdditionalFields_Boolean", "DATE": "#/components/schemas/A02_Request_ShopAdditionalFields_Date", "LINK": "#/components/schemas/A02_Request_ShopAdditionalFields_Link", "LIST": "#/components/schemas/A02_Request_ShopAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/A02_Request_ShopAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/A02_Request_ShopAdditionalFields_Numeric", "REGEX": "#/components/schemas/A02_Request_ShopAdditionalFields_Regex", "STRING": "#/components/schemas/A02_Request_ShopAdditionalFields_String", "TEXTAREA": "#/components/schemas/A02_Request_ShopAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "A02_Request_ShopAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Request_ShopAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Request_ShopAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200": { "type": "object", "properties": { "errors": { "type": "array", "description": "List of errors encountered when updating the shop", "items": { "$ref": "#/components/schemas/A02_Response_200_Errors" } }, "updated": { "$ref": "#/components/schemas/A02_Response_200_Updated", "description": "Details of the modified shop" } } }, "A02_Response_200_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" } }, "required": [ "code", "field", "message" ] }, "A02_Response_200_Updated": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/A02_Response_200_Updated_Address", "description": "Address of the shop" }, "channels": { "type": "array", "description": "List of the channel codes associated to the shop", "items": { "type": "string" } }, "closed_from": { "type": "string", "format": "date-time", "description": "The start date of the closing of the shop" }, "closed_to": { "type": "string", "format": "date-time", "description": "The end date of the closing of the shop" }, "default_billing_information": { "$ref": "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation", "description": "The default billing information of the shop, used for invoicing and reporting purposes" }, "description": { "type": "string", "description": "Shop description" }, "email": { "type": "string", "description": "Shop email" }, "fax": { "type": "string", "description": "Shop fax" }, "is_professional": { "type": "boolean", "description": "Whether or not the shop is professional" }, "model": { "type": "string", "description": "Shop platform model, current possible values :\n\n\nEnum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n" }, "payment_info": { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo", "description": "Payment information of the shop" }, "payment_method_mandatory": { "type": "boolean", "description": "Payment method is mandatory" }, "pro_details": { "$ref": "#/components/schemas/A02_Response_200_Updated_ProDetails", "deprecated": true, "description": "

Professional details of the shop

Use \"default_billing_information\" instead

" }, "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_Response_200_Updated_ProducerIdentifiers" }, "uniqueItems": true }, "recycling_policy": { "type": "string", "description": "Recycling policy of the shop - only available if the operator setting Activate data collection related to circular economy regulations has been enabled." }, "return_policy": { "type": "string", "description": "Return policy of the shop" }, "shipping": { "$ref": "#/components/schemas/A02_Response_200_Updated_Shipping", "description": "Shop shipping configuration" }, "shipping_country": { "type": "string", "description": "Shipping country of the shop\n\nEnum: `\"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\"`\n" }, "shop_additional_fields": { "type": "array", "description": "Additional fields of the shop", "items": { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } }, "shop_name": { "type": "string", "description": "Shop name" }, "specific_billing_informations": { "type": "array", "description": "The list of specific billing information of the shop, used for invoicing and reporting purposes\n
Applies only when the shop is professional\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\n\nEnum: `\"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\"`\n" }, "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.\n
Applies only when the shop is professional\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.\n
Applies only when the shop is professional\n" }, "fiscal_representative": { "$ref": "#/components/schemas/A02_Response_200_Updated_DefaultBillingInformation_FiscalRepresentative", "description": "The fiscal representative associated to the billing information.\n
Applies only when the shop is professional\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.\n
Applies only when the shop is non 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." } }, "required": [ "default_language", "id", "registration_address" ] }, "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.\n
Applies only when the operator is registered in the EU, and the seller is registered in France.\n" }, "company_registration_city": { "type": "string", "description": "The city of the company's registry office.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n" }, "is_in_liquidation": { "type": "boolean", "description": "Indicates whether the company is in liquidation or not.\n
Applies only when the operator is registered in the EU\n" }, "legal_form": { "type": "string", "description": "The legal form of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital": { "type": "number", "format": "with decimals", "description": "The share capital of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital_currency": { "type": "string", "description": "The share capital currency of the company.\n
Applies only when the operator is registered in the EU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\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\n\nEnum: `\"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\"`\n" }, "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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "civility", "company_registration_name", "company_registration_number", "country_iso_code", "first_name", "last_name", "street_1" ] }, "A02_Response_200_Updated_DefaultBillingInformation_PersonalInformation": { "type": "object", "properties": { "birth_city": { "type": "string", "description": "The city of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "birth_country": { "type": "string", "description": "The country of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n\n\nEnum: `\"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\"`\n" }, "birth_date": { "type": "string", "format": "date", "description": "The birth date of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "civility": { "type": "string", "description": "The civility of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "first_name": { "type": "string", "description": "The first name of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "last_name": { "type": "string", "description": "The last name of the shop owner.\n
Applies only when the shop is non 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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "country_iso_code", "street_1" ] }, "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", "description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"GUATEMALAN\"`, `\"SG\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"SERBIAN\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`\n" }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 } }, "required": [ "owner" ] }, "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]+" } }, "required": [ "bank_account_number", "bank_name", "routing_number" ] }, "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 } }, "required": [ "auban", "aubsb", "bank_name" ] }, "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 type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "pattern": "[0-9]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "pattern": "[0-9]+" }, "pix_key": { "type": "string", "description": "Pix key", "maxLength": 255, "minLength": 0 } }, "required": [ "account_number", "bank_account_type", "bank_code", "bank_name", "branch_code" ] }, "A02_Response_200_Updated_PaymentInfo_Canadian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 12, "minLength": 5, "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 }, "institution_number": { "type": "string", "description": "Bank institution number", "pattern": "[0-9]+" }, "swift_code": { "type": "string", "description": "Bank account swift code" }, "transit_number": { "type": "string", "description": "Bank transit number", "pattern": "[0-9]+" } }, "required": [ "bank_account_number", "bank_name", "institution_number", "transit_number" ] }, "A02_Response_200_Updated_PaymentInfo_Colombian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 } }, "required": [ "account_number", "bank_account_type", "bank_name" ] }, "A02_Response_200_Updated_PaymentInfo_Guatemalan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 255, "minLength": 1, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 } }, "required": [ "account_number", "bank_account_type", "bank_name" ] }, "A02_Response_200_Updated_PaymentInfo_Hk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 12, "minLength": 9, "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 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "swift_code" ] }, "A02_Response_200_Updated_PaymentInfo_Iban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "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" }, "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "bank_name", "bic", "iban" ] }, "A02_Response_200_Updated_PaymentInfo_Indian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 20, "minLength": 6, "pattern": "[0-9a-zA-Z]+" }, "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 }, "indian_financial_system_code": { "type": "string", "description": "Indian financial system code" }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "account_number", "bank_name", "indian_financial_system_code" ] }, "A02_Response_200_Updated_PaymentInfo_Israeli": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 9, "minLength": 1, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "maxLength": 4, "minLength": 1, "pattern": "[0-9]+" }, "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 }, "branch_name": { "type": "string", "description": "Branch name" } }, "required": [ "bank_account_number", "bank_code", "bank_name" ] }, "A02_Response_200_Updated_PaymentInfo_Japanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 8, "minLength": 6 }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "pattern": "[0-9]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "pattern": "[0-9]+" }, "branch_name": { "type": "string", "description": "Branch name" }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_account_type", "bank_code", "bank_name", "branch_code", "branch_name" ] }, "A02_Response_200_Updated_PaymentInfo_Mexican": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 20, "minLength": 5, "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 }, "clabe": { "type": "string", "description": "Clave Bancaria Estandarizada" } }, "required": [ "bank_account_number", "bank_name", "clabe" ] }, "A02_Response_200_Updated_PaymentInfo_Nuban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "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 }, "nuban": { "type": "string", "description": "The bank account NUBAN code", "maxLength": 255, "minLength": 10 } }, "required": [ "bank_name", "nuban" ] }, "A02_Response_200_Updated_PaymentInfo_Nzbsb": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "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 }, "nzban": { "type": "string", "description": "Bank Account Number", "maxLength": 10, "minLength": 10 }, "nzbsb": { "type": "string", "description": "Bank State Branch code." } }, "required": [ "bank_name", "nzban", "nzbsb" ] }, "A02_Response_200_Updated_PaymentInfo_Payout": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number (required for LOCAL_UK and INTERNATIONAL formats)" }, "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 (required for INTERNATIONAL format)" }, "iban": { "type": "string", "description": "Bank account IBAN (required for LOCAL_IBAN format)" }, "payout_format": { "type": "string", "description": "Payout format type\n\nEnum: `\"LOCAL_IBAN\"`, `\"LOCAL_UK\"`, `\"INTERNATIONAL\"`\n" }, "sort_code": { "type": "string", "description": "Bank Sort Code (required for LOCAL_UK format)", "pattern": "[0-9]+" } }, "required": [ "bank_name", "payout_format" ] }, "A02_Response_200_Updated_PaymentInfo_Philippines": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 16, "minLength": 10, "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 } }, "required": [ "bank_account_number", "bank_name" ] }, "A02_Response_200_Updated_PaymentInfo_Serbian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "pattern": "[0-9]+" }, "bank_branch_number": { "type": "string", "description": "Bank branch number", "maxLength": 10, "minLength": 1 }, "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" }, "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "bank_account_number", "bank_branch_number", "bank_name" ] }, "A02_Response_200_Updated_PaymentInfo_Sg": { "type": "object", "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 12, "minLength": 9, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_key": { "type": "string", "description": "Bank Key", "pattern": "[0-9]+" }, "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 }, "owner": { "type": "string", "description": "Name of the owner of the payment information", "maxLength": 100, "minLength": 1 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "owner", "swift_code" ] }, "A02_Response_200_Updated_PaymentInfo_Taiwanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 14, "minLength": 8, "pattern": "[0-9]+" }, "bank_city": { "type": "string", "description": "Bank city", "maxLength": 100, "minLength": 3 }, "bank_code": { "type": "string", "description": "Bank code", "maxLength": 3, "minLength": 2, "pattern": "[0-9a-zA-Z]+" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "maxLength": 4, "minLength": 3, "pattern": "[0-9a-zA-Z]+" } }, "required": [ "account_number", "bank_code", "bank_name", "branch_code" ] }, "A02_Response_200_Updated_PaymentInfo_Thai": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 12, "minLength": 10, "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 } }, "required": [ "account_number", "bank_name" ] }, "A02_Response_200_Updated_PaymentInfo_Uk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number", "maxLength": 11, "minLength": 6, "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_sort_code": { "type": "string", "description": "Bank Sort Code (Size must be 6 digits)", "pattern": "[0-9]+" }, "bank_street": { "type": "string", "description": "Bank street name", "maxLength": 100, "minLength": 3 }, "bank_zip": { "type": "string", "description": "Bank zip code", "maxLength": 255, "minLength": 0 }, "swift_code": { "type": "string", "description": "Bank account swift code" } }, "required": [ "bank_account_number", "bank_name", "bank_sort_code" ] }, "A02_Response_200_Updated_PaymentInfo_Uruguayan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number", "maxLength": 20, "minLength": 5, "pattern": "[0-9]+" }, "bank_account_type": { "type": "string", "description": "Account type
\n\nEnum: `\"C\"`, `\"P\"`\n" }, "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 }, "branch_code": { "type": "string", "description": "Branch code", "maxLength": 10, "minLength": 1, "pattern": "[0-9]+" } }, "required": [ "account_number", "bank_account_type", "bank_name", "branch_code" ] }, "A02_Response_200_Updated_PaymentInfo_Vietnamese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number", "maxLength": 255, "minLength": 1, "pattern": "[0-9a-zA-Z]+" }, "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 }, "branch_name": { "type": "string", "description": "Branch name", "maxLength": 255, "minLength": 0, "pattern": "[0-9a-zA-Z]+" } }, "required": [ "bank_account_number", "bank_name" ] }, "A02_Response_200_Updated_ProDetails": { "type": "object", "deprecated": true, "properties": { "corporate_name": { "type": "string", "deprecated": true, "description": "

Corporate name of the shop

Use \"default_billing_information.company_registration_name\" attribute instead

" }, "identification_number": { "type": "string", "deprecated": true, "description": "

Identification number of the shop

Use \"default_billing_information.company_registration_number\" attribute instead

" }, "tax_identification_number": { "type": "string", "deprecated": true, "description": "

Tax identification number of the shop

Use \"default_billing_information.tax_identification_number\" attribute instead if the operator's tax number country is one of the following: Caribbean Netherlands, Cuba, Curaçao, Djibouti, Eritrea, Guam, South Korea, Liberia, Malaysia, Myanmar,PuertoRico, Solomon Islands, Somalia, South Sudan, Timor-Leste, Tuvalu, United States, or Yemen. Use \"default_billing_information.local_tax_number\" attribute instead otherwise

" } } }, "A02_Response_200_Updated_ProducerIdentifiers": { "type": "object", "properties": { "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Shop producer identifier.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code", "producer_id" ] }, "A02_Response_200_Updated_Shipping": { "type": "object", "properties": { "lead_time_to_ship": { "type": "integer", "format": "int32", "description": "Default lead time to ship of the shop" } } }, "A02_Response_200_Updated_ShopAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_Boolean", "DATE": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_Date", "LINK": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_Link", "LIST": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_Numeric", "REGEX": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_Regex", "STRING": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_String", "TEXTAREA": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "A02_Response_200_Updated_ShopAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_ShopAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/A02_Response_200_Updated_ShopAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "A02_Response_200_Updated_SpecificBillingInformations": { "type": "object", "properties": { "corporate_information": { "$ref": "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_CorporateInformation", "description": "The corporate information of the shop.\n
Applies only when the shop is professional\n" }, "fiscal_information": { "$ref": "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_FiscalInformation", "description": "The fiscal information of the shop.\n
Applies only when the shop is professional\n" }, "fiscal_representative": { "$ref": "#/components/schemas/A02_Response_200_Updated_SpecificBillingInformations_FiscalRepresentative", "description": "The fiscal representative associated to the billing information.\n
Applies only when the shop is professional\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.\n
Applies only when the shop is non 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." } }, "required": [ "id", "registration_address" ] }, "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.\n
Applies only when the operator is registered in the EU, and the seller is registered in France.\n" }, "company_registration_city": { "type": "string", "description": "The city of the company's registry office.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU 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.\n
Applies only when the operator is registered in the EU and the seller is registered in Italy.\n\n\nEnum: `\"SINGLE\"`, `\"SEVERAL\"`\n" }, "is_in_liquidation": { "type": "boolean", "description": "Indicates whether the company is in liquidation or not.\n
Applies only when the operator is registered in the EU\n" }, "legal_form": { "type": "string", "description": "The legal form of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital": { "type": "number", "format": "with decimals", "description": "The share capital of the company.\n
Applies only when the operator is registered in the EU\n" }, "share_capital_currency": { "type": "string", "description": "The share capital currency of the company.\n
Applies only when the operator is registered in the EU\n\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\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\n\nEnum: `\"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\"`\n" }, "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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "civility", "company_registration_name", "company_registration_number", "country_iso_code", "first_name", "last_name", "street_1" ] }, "A02_Response_200_Updated_SpecificBillingInformations_PersonalInformation": { "type": "object", "properties": { "birth_city": { "type": "string", "description": "The city of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "birth_country": { "type": "string", "description": "The country of birth of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n\n\nEnum: `\"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\"`\n" }, "birth_date": { "type": "string", "format": "date", "description": "The birth date of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "civility": { "type": "string", "description": "The civility of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "first_name": { "type": "string", "description": "The first name of the shop owner.\n
Applies only when the shop is non professional or professional sole trader.\n" }, "last_name": { "type": "string", "description": "The last name of the shop owner.\n
Applies only when the shop is non 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\n\nEnum: `\"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\"`\n" }, "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" } }, "required": [ "city", "country_iso_code", "street_1" ] }, "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\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_ApprovalRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_AutoRefusedRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_AverageCart": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_AverageCartWithShipping": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_CancelationRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_ConsecutiveRefusedOrdersCount": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_EvaluationsCount": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_Grade": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_IncidentRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_LateShipmentRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_OffersCount": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_OrderMessagesResponseDelay": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_OrdersCount": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_RefundRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_ReturnRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_ShippingDelay": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "integer", "format": "int64", "description": "The statistic value" } } }, "A21_Response_200_TotalRevenue": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "A21_Response_200_ValidTrackingRate": { "type": "object", "properties": { "period": { "type": "string", "description": "The statistic period\n\nEnum: `\"ALL_SINCE_BEGINNING\"`, `\"LAST_MONTH\"`, `\"LAST_THREE_MONTHS\"`, `\"LAST_SIX_MONTHS\"`, `\"LAST_YEAR\"`\n" }, "value": { "type": "number", "format": "with decimals", "description": "The statistic value" } } }, "AF01_Response_200": { "type": "object", "properties": { "additional_fields": { "type": "array", "items": { "$ref": "#/components/schemas/AF01_Response_200_AdditionalFields" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true } }, "required": [ "additional_fields", "total_count" ] }, "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" }, "default_value": { "type": "string", "deprecated": true }, "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\n\nEnum: `\"SHOP\"`, `\"OFFER\"`, `\"ORDER_LINE\"`, `\"ORDER\"`\n" }, "label": { "type": "string", "description": "Additional field label " }, "personal_data": { "type": "boolean", "description": "Whether or not this additional field contains personal data. When set to true, this field's value will be automatically cleared whenever an order is anonymized. Default to false.
This field is only present for additional fields linked to an 'ORDER' or 'ORDER_LINE' entity" }, "regex": { "type": "string", "description": "The regular expression that is used to validate the value value of this field.
This field is only present for additional fields of type 'REGEX'." }, "required": { "type": "boolean", "description": "Whether or not this additionnal field will be required" }, "type": { "type": "string", "description": "Additional field type:\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code", "editable", "label", "required", "type" ] }, "CH11_Response_200": { "type": "object", "properties": { "channels": { "type": "array", "description": "List of channels", "items": { "$ref": "#/components/schemas/CH11_Response_200_Channels" } } } }, "CH11_Response_200_Channels": { "type": "object", "properties": { "code": { "type": "string", "description": "Channel code" }, "description": { "type": "string", "description": "Channel description" }, "label": { "type": "string", "description": "Channel label " } }, "required": [ "code", "description", "label" ] }, "CUR01_Response_200": { "type": "object", "properties": { "currencies": { "type": "array", "description": "List of currencies", "items": { "$ref": "#/components/schemas/CUR01_Response_200_Currencies" } } }, "required": [ "currencies" ] }, "CUR01_Response_200_Currencies": { "type": "object", "properties": { "code": { "type": "string", "description": "Currency code" }, "label": { "type": "string", "description": "Currency label" }, "platform_default": { "type": "boolean", "description": "Default currency of the platform" } }, "required": [ "code", "label" ] }, "DO01_Response_200": { "type": "object", "properties": { "documents": { "type": "array", "description": "Document types", "items": { "$ref": "#/components/schemas/DO01_Response_200_Documents" } } }, "required": [ "documents" ] }, "DO01_Response_200_Documents": { "type": "object", "properties": { "code": { "type": "string", "description": "Type code" }, "description": { "type": "string", "description": "Type description" }, "entity": { "type": "string", "description": "Entity type linked to the document type\n\nEnum: `\"ORDER\"`, `\"SHOP\"`\n" }, "label": { "type": "string", "description": "Type label " }, "mime_types": { "type": "array", "description": "Authorized mime types", "items": { "type": "string" } } }, "required": [ "code", "description", "entity", "label" ] }, "DR11_Response_200": { "type": "object", "properties": { "data": { "type": "array", "description": "Page of data", "items": { "$ref": "#/components/schemas/DR11_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." } }, "required": [ "data" ] }, "DR11_Response_200_Data": { "type": "object", "properties": { "currency_iso_code": { "type": "string", "description": "The currency used for the accounting document request.\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date_created": { "type": "string", "format": "date-time", "description": "The accounting document request creation date." }, "document_details": { "type": "array", "description": "Details about each accounting document representation.", "items": { "$ref": "#/components/schemas/DR11_Response_200_Data_DocumentDetails" } }, "document_number": { "type": "string", "description": "The accounting document number.\n\nIt is only populated once an accounting document has been issued (e.g. when state is `ISSUED` or `CANCELED`)." }, "document_upload_date": { "type": "string", "format": "date-time", "description": "The last upload date of the accounting document representations.\n\nIt is only populated once an accounting document has been issued (e.g. when state is `ISSUED` or `CANCELED`)." }, "due_date": { "type": "string", "format": "date-time", "description": "The accounting document due date." }, "entities": { "$ref": "#/components/schemas/DR11_Response_200_Data_Entities", "description": "Node containing additional information depending on the type of the accounting document request.\n\nSub-fields are selectively populated depending on `entity_type`; see individual field descriptions." }, "entity_date_created": { "type": "string", "format": "date-time", "description": "The creation date of the entity the accounting document request relates to.\n\nThis is not applicable when entity_type is `SHOP_BILLING_CYCLE_PURCHASE_ORDER`." }, "entity_id": { "type": "string", "description": "The identifier of the entity the accounting document request relates to. The format varies by `entity_type`." }, "entity_type": { "type": "string", "description": "The type of the entity the accounting document request relates to.\n\nEnum: `\"PRODUCT_LOGISTIC_ORDER\"`, `\"SHOP_BILLING_CYCLE_PURCHASE_ORDER\"`, `\"LOGISTIC_PURCHASE_ORDER\"`, `\"FEES\"`, `\"ONE_OFF_FEES\"`\n" }, "id": { "type": "string", "description": "The accounting document request unique identifier." }, "initial_documents": { "type": "array", "description": "Information about the initial accounting document(s) or accounting document request(s).\n\nIt is only provided in the case of a `CREDIT_NOTE` or a reissued `INVOICE`.", "items": { "$ref": "#/components/schemas/DR11_Response_200_Data_InitialDocuments" } }, "initial_payment_state": { "type": "string", "description": "The accounting document payment state when the document request was created.\n\nEnum: `\"PAID\"`, `\"NOT_PAID\"`\n" }, "issue_date": { "type": "string", "format": "date-time", "description": "The accounting document request issue date." }, "issuer": { "$ref": "#/components/schemas/DR11_Response_200_Data_Issuer", "description": "The issuer details for the accounting document." }, "last_updated": { "type": "string", "format": "date-time", "description": "The accounting document request last updated date." }, "payment": { "$ref": "#/components/schemas/DR11_Response_200_Data_Payment", "description": "The accounting document payment details.\n\nIt is only populated after the payment has been confirmed." }, "payment_destination": { "$ref": "#/components/schemas/DR11_Response_200_Data_PaymentDestination", "description": "Information about how the accounting document payment should be settled." }, "payment_terms": { "$ref": "#/components/schemas/DR11_Response_200_Data_PaymentTerms", "description": "The accounting document payment terms.\n\nIt is always provided when `entity_type` is `SHOP_BILLING_CYCLE_PURCHASE_ORDER`, `LOGISTIC_PURCHASE_ORDER`, `FEES`, `ONE_OFF_FEES`.\nIt is optional when `entity_type` is `PRODUCT_LOGISTIC_ORDER`." }, "recipient": { "$ref": "#/components/schemas/DR11_Response_200_Data_Recipient", "description": "The recipient details for the accounting document." }, "state": { "type": "string", "description": "The accounting document request state.\n\nEnum: `\"STAGING\"`, `\"TO_PROCESS\"`, `\"ISSUED\"`, `\"CANCELED\"`\n" }, "taxes": { "type": "array", "description": "A breakdown of `total_tax_amount` by tax code and rate.", "items": { "$ref": "#/components/schemas/DR11_Response_200_Data_Taxes" } }, "total_amount_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The total amount for the accounting document, excluding taxes." }, "total_amount_including_taxes": { "type": "number", "format": "with decimals", "description": "The total amount for the accounting document, including taxes." }, "total_tax_amount": { "type": "number", "format": "with decimals", "description": "The total tax amount for the accounting document." }, "type": { "type": "string", "description": "The accounting document request type.\n\nEnum: `\"INVOICE\"`, `\"CREDIT_NOTE\"`\n" } }, "required": [ "currency_iso_code", "date_created", "document_details", "due_date", "entity_id", "entity_type", "id", "initial_payment_state", "issue_date", "issuer", "last_updated", "state", "total_amount_excluding_taxes", "total_amount_including_taxes", "total_tax_amount", "type" ] }, "DR11_Response_200_Data_DocumentDetails": { "type": "object", "properties": { "format": { "type": "string", "description": "The document format.\n\nEnum: `\"PDF\"`, `\"cXML\"`\n" } }, "required": [ "format" ] }, "DR11_Response_200_Data_Entities": { "type": "object", "properties": { "delivery_bill_information": { "type": "array", "description": "The delivery bill information.\n\nIt may be provided when the accounting document request is `LOGISTIC_PURCHASE_ORDER` or `PRODUCT_LOGISTIC_ORDER`.", "items": { "$ref": "#/components/schemas/DR11_Response_200_Data_Entities_DeliveryBillInformation" } }, "order_additional_fields": { "type": "array", "description": "The order additional fields (also known as custom fields).", "items": { "$ref": "#/components/schemas/DR11_Response_200_Data_Entities_OrderAdditionalFields" } }, "ship_to_iso_country_code": { "type": "string", "description": "The ISO country code of the ship-to destination.\n\nIt is only provided when the accounting document request is `SHOP_BILLING_CYCLE_PURCHASE_ORDER`." }, "shipping_information": { "$ref": "#/components/schemas/DR11_Response_200_Data_Entities_ShippingInformation", "description": "The shipping information.\n\nIt may be provided when the accounting document request is `LOGISTIC_PURCHASE_ORDER`." }, "shop_billing_cycle": { "$ref": "#/components/schemas/DR11_Response_200_Data_Entities_ShopBillingCycle", "description": "The shop billing cycle information.\n\nIt is only provided when the accounting document request is `SHOP_BILLING_CYCLE_PURCHASE_ORDER`, `LOGISTIC_PURCHASE_ORDER`, `FEES`, or `ONE_OFF_FEES`." } } }, "DR11_Response_200_Data_Entities_DeliveryBillInformation": { "type": "object", "properties": { "delivery_bill_date": { "type": "string", "format": "date", "description": "The delivery bill date." }, "delivery_bill_id": { "type": "string", "description": "The delivery bill identifier." } } }, "DR11_Response_200_Data_Entities_OrderAdditionalFields": { "type": "object", "properties": { "code": { "type": "string", "description": "The additional field code.", "maxLength": 36 }, "type": { "type": "string", "description": "The additional field type.\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" }, "value": { "type": "string", "description": "The additional field value." } } }, "DR11_Response_200_Data_Entities_ShippingInformation": { "type": "object", "properties": { "ship_to_address": { "$ref": "#/components/schemas/DR11_Response_200_Data_Entities_ShippingInformation_ShipToAddress", "description": "The shipping address information." } } }, "DR11_Response_200_Data_Entities_ShippingInformation_ShipToAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The city of the shipping destination address." }, "civility": { "type": "string", "description": "The civility or title of the recipient (e.g., Mr., Mrs., Dr.)." }, "company": { "type": "string", "description": "The company or organization name of the shipping destination." }, "company2": { "type": "string", "description": "The secondary company or organization name of the shipping destination (e.g., department or subsidiary)." }, "country_iso_code": { "type": "string", "description": "The ISO 3166-1 alpha-3 country code of the shipping destination address." }, "firstname": { "type": "string", "description": "The first name of the recipient." }, "lastname": { "type": "string", "description": "The last name of the recipient." }, "phone": { "type": "string", "description": "The primary phone number of the recipient." }, "phone_secondary": { "type": "string", "description": "The secondary phone number of the recipient." }, "state": { "type": "string", "description": "The state, province, or region of the shipping destination address." }, "street1": { "type": "string", "description": "The primary line of the shipping destination street address (e.g., street number and name)." }, "street2": { "type": "string", "description": "The secondary line of the shipping destination street address (e.g., building, floor, or suite number)." }, "zip_code": { "type": "string", "description": "The postal or zip code of the shipping destination address." } } }, "DR11_Response_200_Data_Entities_ShopBillingCycle": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "description": "The start date of the shop billing cycle." }, "date_to": { "type": "string", "format": "date-time", "description": "The end date of the shop billing cycle." }, "id": { "type": "string", "description": "The identifier of the shop billing cycle." } } }, "DR11_Response_200_Data_InitialDocuments": { "type": "object", "properties": { "id": { "type": "string", "description": "The initial document request unique identifier." }, "issue_date": { "type": "string", "format": "date-time", "description": "The initial document request issue date." }, "number": { "type": "string", "description": "The initial accounting document number." }, "type": { "type": "string", "description": "The initial document request type.\n\nEnum: `\"INVOICE\"`, `\"CREDIT_NOTE\"`\n" } }, "required": [ "id", "issue_date", "type" ] }, "DR11_Response_200_Data_Issuer": { "type": "object", "properties": { "id": { "type": "string", "description": "The issuer's identifier — either the operator's or the shop's billing information identifier." }, "locale": { "type": "string", "description": "The issuer's locale." }, "organization": { "$ref": "#/components/schemas/DR11_Response_200_Data_Issuer_Organization", "description": "The issuer organization information." }, "type": { "type": "string", "description": "The issuer's type.\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`\n" } }, "required": [ "organization", "type" ] }, "DR11_Response_200_Data_Issuer_Organization": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/DR11_Response_200_Data_Issuer_Organization_Address", "description": "The address of the organization." }, "business_activity_code": { "type": "string", "description": "The business activity code of the organization." }, "company_shareholders": { "type": "string", "description": "Indicates if there is a single shareholder or several shareholders." }, "electronic_address": { "type": "string", "description": "Identifier of the organization used to route and deliver e-invoices. It is also known as ‘Routing Identifier’ or ‘PEPPOL Participant ID’." }, "fiscal_representative": { "$ref": "#/components/schemas/DR11_Response_200_Data_Issuer_Organization_FiscalRepresentative", "description": "The fiscal representative of the organization." }, "identification_number": { "type": "string", "description": "The identification number of the organization." }, "is_in_liquidation": { "type": "boolean", "description": "Indicates whether the company is in liquidation or not." }, "legal_form": { "type": "string", "description": "The legal form of the organization." }, "local_tax_number": { "type": "string", "description": "The VAT/GST number." }, "local_tax_number_country": { "type": "string", "description": "The local tax number country of the organization." }, "name": { "type": "string", "description": "The organization name." }, "personal_information": { "$ref": "#/components/schemas/DR11_Response_200_Data_Issuer_Organization_PersonalInformation", "description": "The personal information of the organization." }, "phone_number": { "type": "string", "description": "The contact phone number of the organization." }, "share_capital": { "type": "number", "format": "with decimals", "description": "The share capital of the organization." }, "share_capital_currency": { "type": "string", "description": "The share capital currency of the organization." }, "sole_trader": { "type": "boolean", "description": "Indicates if the organization is a sole trader." }, "tax_identification_number": { "type": "string", "description": "The tax identification number of the organization." }, "tax_number_country": { "type": "string", "description": "The tax number country of the organization." }, "trade_company_registration_location": { "type": "string", "description": "The trade company registration location of the organization." } }, "required": [ "name" ] }, "DR11_Response_200_Data_Issuer_Organization_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address city" }, "country_iso_code": { "type": "string", "description": "Country ISO 3166-1 code of the address" }, "state": { "type": "string", "description": "Address state" }, "street_1": { "type": "string", "description": "First information line of the address street, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country_iso_code", "street_1" ] }, "DR11_Response_200_Data_Issuer_Organization_FiscalRepresentative": { "type": "object", "properties": { "city": { "type": "string", "description": "The city where the fiscal representative is located." }, "civility": { "type": "string", "description": "The civility of the fiscal representative." }, "company_registration_name": { "type": "string", "description": "The name of the fiscal representative." }, "company_registration_number": { "type": "string", "description": "The registration number of the fiscal representative." }, "country_iso_code": { "type": "string", "description": "The country ISO 3166-1 code of the fiscal representative address." }, "first_name": { "type": "string", "description": "The first name of the fiscal representative." }, "last_name": { "type": "string", "description": "The last name of the fiscal representative." }, "local_tax_number": { "type": "string", "description": "The VAT/GST number." }, "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, mandatory except if country_iso_code = \"JPN\"." }, "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." } }, "required": [ "city", "civility", "company_registration_name", "company_registration_number", "country_iso_code", "first_name", "last_name", "street_1" ] }, "DR11_Response_200_Data_Issuer_Organization_PersonalInformation": { "type": "object", "properties": { "civility": { "type": "string", "description": "The civility of the shop owner." }, "first_name": { "type": "string", "description": "The first name of the shop owner." }, "last_name": { "type": "string", "description": "The last name of the shop owner." } } }, "DR11_Response_200_Data_Payment": { "type": "object", "properties": { "reference": { "type": "string", "description": "The payment transaction reference." }, "state": { "type": "string", "description": "The payment state.\n\nEnum: `\"PAID\"`, `\"PENDING\"`\n" }, "transaction_date": { "type": "string", "format": "date-time", "description": "The payment transaction date." } } }, "DR11_Response_200_Data_PaymentDestination": { "type": "object", "discriminator": { "mapping": { "IBAN": "#/components/schemas/DR11_Response_200_Data_PaymentDestination_Iban" }, "propertyName": "@type" }, "properties": { "@type": { "type": "string", "description": "The payment destination type.\n\nEnum: `\"IBAN\"`\n" }, "payment_reference": { "type": "string", "description": "The payment reference for bank transfer." } }, "required": [ "@type" ] }, "DR11_Response_200_Data_PaymentDestination_Iban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR11_Response_200_Data_PaymentDestination" } ], "properties": { "iban": { "type": "string", "description": "Bank account IBAN" } }, "required": [ "iban" ] }, "DR11_Response_200_Data_PaymentTerms": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32", "description": "The number of days for the payment terms." }, "type": { "type": "string", "description": "The payment terms type.\n\n- `END_OF_MONTH`: payment is due after a number of calendar days following the invoice issue date, at the end of the given month.\n- `NET`: payment is due after a number of calendar days following the invoice issue date.\n\nEnum: `\"END_OF_MONTH\"`, `\"NET\"`\n" } } }, "DR11_Response_200_Data_Recipient": { "type": "object", "properties": { "billing_address": { "$ref": "#/components/schemas/DR11_Response_200_Data_Recipient_BillingAddress", "description": "The billing address." }, "id": { "type": "string", "description": "The recipient's identifier.\n\nFor a customer, this is the customer identifier.\nFor an operator, this is the operator's billing information identifier." }, "locale": { "type": "string", "description": "The recipient's locale." }, "organization": { "$ref": "#/components/schemas/DR11_Response_200_Data_Recipient_Organization", "description": "The recipient organization, if any." }, "shipping_address": { "$ref": "#/components/schemas/DR11_Response_200_Data_Recipient_ShippingAddress", "description": "The shipping address." }, "type": { "type": "string", "description": "The recipient type (customer, operator, or shop).\n\nThis is provided when `entity_type` is `FEES` or `ONE_OFF_FEES`.\n\nEnum: `\"CUSTOMER\"`, `\"SHOP\"`, `\"OPERATOR\"`\n" } }, "required": [ "billing_address", "id" ] }, "DR11_Response_200_Data_Recipient_BillingAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The address city." }, "civility": { "type": "string", "description": "The civility of the person associated with the address." }, "company": { "type": "string", "description": "The company name." }, "company_2": { "type": "string", "description": "The secondary company information of the person associated with the address." }, "country": { "type": "string", "description": "The address country." }, "country_iso_code": { "type": "string", "description": "The ISO 3166-1 country code of the address." }, "firstname": { "type": "string", "description": "The first name of the person associated with the address." }, "lastname": { "type": "string", "description": "The last name of the person associated with the address." }, "state": { "type": "string", "description": "The address state." }, "street_1": { "type": "string", "description": "The first line of the address street, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "The second line of the address street." }, "zip_code": { "type": "string", "description": "The address zip code." } }, "required": [ "city", "country", "lastname", "street_1" ] }, "DR11_Response_200_Data_Recipient_Organization": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/DR11_Response_200_Data_Recipient_Organization_Address", "description": "The address of the organization." }, "business_activity_code": { "type": "string", "description": "The business activity code of the organization." }, "company_shareholders": { "type": "string", "description": "Indicates if there is a single shareholder or several shareholders." }, "electronic_address": { "type": "string", "description": "Identifier of the organization used to route and deliver e-invoices. It is also known as ‘Routing Identifier’ or ‘PEPPOL Participant ID’." }, "identification_number": { "type": "string", "description": "The identification number of the organization." }, "is_in_liquidation": { "type": "boolean", "description": "Indicates whether the company is in liquidation or not." }, "legal_form": { "type": "string", "description": "The legal form of the organization." }, "local_tax_number": { "type": "string", "description": "The VAT/GST number." }, "local_tax_number_country": { "type": "string", "description": "The local tax number country of the organization." }, "name": { "type": "string", "description": "The organization name." }, "organization_id": { "type": "string", "description": "Identifier of the customer organization" }, "phone_number": { "type": "string", "description": "The contact phone number of the organization." }, "share_capital": { "type": "number", "format": "with decimals", "description": "The share capital of the organization." }, "share_capital_currency": { "type": "string", "description": "The share capital currency of the organization." }, "tax_identification_number": { "type": "string", "description": "The tax identification number of the organization." }, "tax_number_country": { "type": "string", "description": "The tax number country of the organization." }, "trade_company_registration_location": { "type": "string", "description": "The trade company registration location of the organization." } }, "required": [ "name" ] }, "DR11_Response_200_Data_Recipient_Organization_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address city" }, "country_iso_code": { "type": "string", "description": "Country ISO 3166-1 code of the address" }, "state": { "type": "string", "description": "Address state" }, "street_1": { "type": "string", "description": "First information line of the address street, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country_iso_code", "street_1" ] }, "DR11_Response_200_Data_Recipient_ShippingAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The address city." }, "civility": { "type": "string", "description": "The civility of the person associated with the address." }, "company": { "type": "string", "description": "The company name." }, "company_2": { "type": "string", "description": "The secondary company information of the person associated with the address." }, "country": { "type": "string", "description": "The address country." }, "country_iso_code": { "type": "string", "description": "The ISO 3166-1 country code of the address." }, "firstname": { "type": "string", "description": "The first name of the person associated with the address." }, "lastname": { "type": "string", "description": "The last name of the person associated with the address." }, "state": { "type": "string", "description": "The address state." }, "street_1": { "type": "string", "description": "The first line of the address street, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "The second line of the address street." }, "zip_code": { "type": "string", "description": "The address zip code." } }, "required": [ "city", "country", "lastname", "street_1" ] }, "DR11_Response_200_Data_Taxes": { "type": "object", "properties": { "code": { "type": "string", "description": "The tax code." }, "rate": { "type": "number", "format": "with decimals", "description": "The tax rate." }, "total_amount": { "type": "number", "format": "with decimals", "description": "The total tax amount, aggregated by tax code and rate." } }, "required": [ "code", "total_amount" ] }, "DR12_Response_200": { "type": "object", "properties": { "data": { "type": "array", "description": "Page of data", "items": { "$ref": "#/components/schemas/DR12_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." } }, "required": [ "data" ] }, "DR12_Response_200_Data": { "type": "object", "discriminator": { "mapping": { "FEES_CREDIT_COMMISSION_REFUND": "#/components/schemas/DR12_Response_200_Data_FeesCreditCommissionRefund", "FEES_CREDIT_ONE_OFF": "#/components/schemas/DR12_Response_200_Data_FeesCreditOneOff", "FEES_DEBIT_COMMISSION": "#/components/schemas/DR12_Response_200_Data_FeesDebitCommission", "FEES_DEBIT_ONE_OFF": "#/components/schemas/DR12_Response_200_Data_FeesDebitOneOff", "FEES_DEBIT_SELLER_FEE_ON_ORDER": "#/components/schemas/DR12_Response_200_Data_FeesDebitSellerFeeOnOrder", "FEES_DEBIT_SELLER_PENALTY_FEE": "#/components/schemas/DR12_Response_200_Data_FeesDebitSellerPenaltyFee", "FEES_DEBIT_SUBSCRIPTION": "#/components/schemas/DR12_Response_200_Data_FeesDebitSubscription", "PRODUCT_CREDIT_CANCEL": "#/components/schemas/DR12_Response_200_Data_ProductCreditCancel", "PRODUCT_CREDIT_CANCEL_ADJUSTMENT": "#/components/schemas/DR12_Response_200_Data_ProductCreditCancelAdjustment", "PRODUCT_CREDIT_CANCEL_COMMERCIAL_GESTURE": "#/components/schemas/DR12_Response_200_Data_ProductCreditCancelCommercialGesture", "PRODUCT_CREDIT_REFUND": "#/components/schemas/DR12_Response_200_Data_ProductCreditRefund", "PRODUCT_CREDIT_REFUND_ADJUSTMENT": "#/components/schemas/DR12_Response_200_Data_ProductCreditRefundAdjustment", "PRODUCT_CREDIT_REFUND_COMMERCIAL_GESTURE": "#/components/schemas/DR12_Response_200_Data_ProductCreditRefundCommercialGesture", "PRODUCT_DEBIT": "#/components/schemas/DR12_Response_200_Data_ProductDebit", "PURCHASE_ORDER_CREDIT": "#/components/schemas/DR12_Response_200_Data_PurchaseOrderCredit", "PURCHASE_ORDER_DEBIT": "#/components/schemas/DR12_Response_200_Data_PurchaseOrderDebit" }, "propertyName": "entity_type" }, "properties": { "delivery_bill_information": { "type": "array", "description": "The delivery bill information.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_DeliveryBillInformation" } }, "eco_contributions": { "type": "array", "description": "List of eco-contributions that apply to the accounting document request line.\n\nThis is only available:\n- if the operator activates the circular economy information collection,\n- and when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_EcoContributions" } }, "entity_id": { "type": "string", "description": "The identifier of the entity the accounting document request line relates to." }, "entity_type": { "type": "string", "description": "The type of the entity the accounting document request line relates to.\n\nEnum: `\"PRODUCT_DEBIT\"`, `\"PRODUCT_CREDIT_CANCEL\"`, `\"PRODUCT_CREDIT_CANCEL_COMMERCIAL_GESTURE\"`, `\"PRODUCT_CREDIT_CANCEL_ADJUSTMENT\"`, `\"PRODUCT_CREDIT_REFUND\"`, `\"PRODUCT_CREDIT_REFUND_COMMERCIAL_GESTURE\"`, `\"PRODUCT_CREDIT_REFUND_ADJUSTMENT\"`, `\"PURCHASE_ORDER_DEBIT\"`, `\"PURCHASE_ORDER_CREDIT\"`, `\"FEES_DEBIT_COMMISSION\"`, `\"FEES_CREDIT_COMMISSION_REFUND\"`, `\"FEES_DEBIT_SUBSCRIPTION\"`, `\"FEES_DEBIT_SELLER_FEE_ON_ORDER\"`, `\"FEES_DEBIT_SELLER_PENALTY_FEE\"`, `\"FEES_CREDIT_ONE_OFF\"`, `\"FEES_DEBIT_ONE_OFF\"`\n" }, "fees_excluding_taxes": { "type": "array", "description": "The fees applied to the order line.\n\nThis may be provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesExcludingTaxes" } }, "id": { "type": "string", "description": "The accounting document request line unique identifier." }, "order": { "$ref": "#/components/schemas/DR12_Response_200_Data_Order", "description": "The order the accounting document request line relates to.\n\nThis is only provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "order_line": { "$ref": "#/components/schemas/DR12_Response_200_Data_OrderLine", "description": "The order line the accounting document request line relates to.\n\nThis may be provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "origin_unit_price_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The original unit price, excluding tax, of the offer associated with the order line.\n\nThis may be provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "origin_unit_price_including_taxes": { "type": "number", "format": "with decimals", "description": "The original unit price including tax of the offer associated with the order line.\n\nThis may be provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "price_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The price excluding taxes for the accounting document request line (after promotions)." }, "product": { "$ref": "#/components/schemas/DR12_Response_200_Data_Product", "description": "The product the accounting document request line relates to.\n\nThis is only provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity for the accounting document request line." }, "shipping_from": { "$ref": "#/components/schemas/DR12_Response_200_Data_ShippingFrom", "description": "From where (country or full address) the order line is shipped.\n\nThis may be provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "shipping_price_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The shipping price excluding taxes for the accounting document request line.\n\nThis is only provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "shipping_taxes": { "type": "array", "description": "The shipping tax breakdown for the accounting document request line, by tax code and rate.\n\nThis is only provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_ShippingTaxes" } }, "shipping_to": { "$ref": "#/components/schemas/DR12_Response_200_Data_ShippingTo", "description": "To where (country or full address) the order line is shipped.\n\nThis may be provided when `entity_type` is `PRODUCT_*` or `PURCHASE_ORDER_*`." }, "shop": { "$ref": "#/components/schemas/DR12_Response_200_Data_Shop", "description": "The shop the accounting document request line relates to." }, "tax_legal_notice": { "type": "string", "description": "The legal notice applying to the accounting document request line." }, "taxes": { "type": "array", "description": "The taxes breakdown for the accounting document request line, by tax code and rate.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_Taxes" } }, "total_price_including_taxes": { "type": "number", "format": "with decimals", "description": "The total price for the accounting document request line." }, "unit_price_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The unit price excluding taxes for the accounting document request line (after promotions)." } }, "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_DeliveryBillInformation": { "type": "object", "properties": { "delivery_bill_date": { "type": "string", "format": "date", "description": "The delivery bill date." }, "delivery_bill_id": { "type": "string", "description": "The delivery bill identifier." } } }, "DR12_Response_200_Data_EcoContributions": { "type": "object", "properties": { "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility category." }, "producer_id": { "type": "string", "deprecated": true, "description": "Producer identifier of the eco-contribution.\n\nThis is always `null`." }, "producer_id_owner": { "type": "string", "deprecated": true, "description": "Owner of the `producer_id`.\n\nThis is always `null`." }, "total_amount": { "type": "number", "format": "with decimals", "description": "The total eco-contribution amount." }, "unit_amount": { "type": "number", "format": "with decimals", "description": "The unit eco-contribution amount." } } }, "DR12_Response_200_Data_FeesCreditCommissionRefund": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "period": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesCreditCommissionRefund_Period", "description": "The period for which the fee is applied." } }, "required": [ "period" ] }, "DR12_Response_200_Data_FeesCreditCommissionRefund_Period": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "description": "The period start date." }, "date_to": { "type": "string", "format": "date-time", "description": "The period end date." } }, "required": [ "date_from", "date_to" ] }, "DR12_Response_200_Data_FeesCreditOneOff": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "description": { "type": "string", "description": "The description of the one-off fee." }, "operation_date": { "type": "string", "format": "date", "description": "The date when the one-off fee operation occurred. This represents the business date of the transaction, not necessarily when it was recorded in the system.", "example": "2026-03-01" }, "references": { "type": "array", "description": "The references associated with this one-off fee line (e.g. external system identifiers, internal tracking codes).", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesCreditOneOff_References" }, "maxItems": 1, "minItems": 0 } }, "required": [ "description", "references" ] }, "DR12_Response_200_Data_FeesCreditOneOff_References": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reference scheme used to identify the related object. This may be a common type, such as EAN or GTIN, but also a custom internal or external type.", "maxLength": 100, "minLength": 1, "pattern": "^[0-9a-zA-Z_-]+$" }, "value": { "type": "string", "description": "The actual reference value within the specified type scheme.", "maxLength": 100, "minLength": 1 } }, "required": [ "type", "value" ] }, "DR12_Response_200_Data_FeesDebitCommission": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "period": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesDebitCommission_Period", "description": "The period for which the fee is applied." } }, "required": [ "period" ] }, "DR12_Response_200_Data_FeesDebitCommission_Period": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "description": "The period start date." }, "date_to": { "type": "string", "format": "date-time", "description": "The period end date." } }, "required": [ "date_from", "date_to" ] }, "DR12_Response_200_Data_FeesDebitOneOff": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "description": { "type": "string", "description": "The description of the one-off fee." }, "operation_date": { "type": "string", "format": "date", "description": "The date when the one-off fee operation occurred. This represents the business date of the transaction, not necessarily when it was recorded in the system.", "example": "2026-03-01" }, "references": { "type": "array", "description": "The references associated with this one-off fee line (e.g. external system identifiers, internal tracking codes).", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesDebitOneOff_References" }, "maxItems": 1, "minItems": 0 } }, "required": [ "description", "references" ] }, "DR12_Response_200_Data_FeesDebitOneOff_References": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of reference scheme used to identify the related object. This may be a common type, such as EAN or GTIN, but also a custom internal or external type.", "maxLength": 100, "minLength": 1, "pattern": "^[0-9a-zA-Z_-]+$" }, "value": { "type": "string", "description": "The actual reference value within the specified type scheme.", "maxLength": 100, "minLength": 1 } }, "required": [ "type", "value" ] }, "DR12_Response_200_Data_FeesDebitSellerFeeOnOrder": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "period": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesDebitSellerFeeOnOrder_Period", "description": "The period for which the fee is applied." } }, "required": [ "period" ] }, "DR12_Response_200_Data_FeesDebitSellerFeeOnOrder_Period": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "description": "The period start date." }, "date_to": { "type": "string", "format": "date-time", "description": "The period end date." } }, "required": [ "date_from", "date_to" ] }, "DR12_Response_200_Data_FeesDebitSellerPenaltyFee": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "period": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesDebitSellerPenaltyFee_Period", "description": "The period for which the fee is applied." } }, "required": [ "period" ] }, "DR12_Response_200_Data_FeesDebitSellerPenaltyFee_Period": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "description": "The period start date." }, "date_to": { "type": "string", "format": "date-time", "description": "The period end date." } }, "required": [ "date_from", "date_to" ] }, "DR12_Response_200_Data_FeesDebitSubscription": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "period": { "$ref": "#/components/schemas/DR12_Response_200_Data_FeesDebitSubscription_Period", "description": "The period for which the fee is applied." } }, "required": [ "period" ] }, "DR12_Response_200_Data_FeesDebitSubscription_Period": { "type": "object", "properties": { "date_from": { "type": "string", "format": "date-time", "description": "The period start date." }, "date_to": { "type": "string", "format": "date-time", "description": "The period end date." } }, "required": [ "date_from", "date_to" ] }, "DR12_Response_200_Data_FeesExcludingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The fee amount.", "minimum": 0 }, "code": { "type": "string", "description": "The fee code." }, "label": { "type": "string", "description": "The fee label." } }, "required": [ "amount", "code", "label" ] }, "DR12_Response_200_Data_Order": { "type": "object", "properties": { "additional_fields": { "type": "array", "description": "The order additional fields (also known as custom fields).", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_Order_AdditionalFields" }, "minItems": 0 }, "commercial_id": { "type": "string", "description": "The order's commercial identifier." }, "date_created": { "type": "string", "format": "date-time", "description": "The order creation date." }, "id": { "type": "string", "description": "The order identifier." }, "reference_for_customer": { "type": "string", "description": "The order reference for the customer." }, "reference_for_seller": { "type": "string", "description": "The order reference for the seller." }, "transaction_info": { "$ref": "#/components/schemas/DR12_Response_200_Data_Order_TransactionInfo", "description": "The transaction information, if any." } }, "required": [ "id" ] }, "DR12_Response_200_Data_OrderLine": { "type": "object", "properties": { "additional_fields": { "type": "array", "description": "The order line additional fields (also known as custom fields).", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_OrderLine_AdditionalFields" }, "minItems": 0 }, "id": { "type": "string", "description": "The order line identifier." } }, "required": [ "id" ] }, "DR12_Response_200_Data_OrderLine_AdditionalFields": { "type": "object", "properties": { "code": { "type": "string", "description": "The additional field code.", "maxLength": 36 }, "type": { "type": "string", "description": "The additional field type.\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" }, "value": { "type": "string", "description": "The additional field value." } } }, "DR12_Response_200_Data_Order_AdditionalFields": { "type": "object", "properties": { "code": { "type": "string", "description": "The additional field code.", "maxLength": 36 }, "type": { "type": "string", "description": "The additional field type.\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" }, "value": { "type": "string", "description": "The additional field value." } } }, "DR12_Response_200_Data_Order_TransactionInfo": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The transaction date." }, "number": { "type": "string", "description": "The transaction number." } }, "required": [ "date", "number" ] }, "DR12_Response_200_Data_Product": { "type": "object", "properties": { "references": { "type": "array", "description": "The product references.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_Product_References" } }, "sku": { "type": "string", "description": "The product SKU." }, "title": { "type": "string", "description": "The product title." } }, "required": [ "references", "title" ] }, "DR12_Response_200_Data_ProductCreditCancel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_ProductCreditCancelAdjustment": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_ProductCreditCancelCommercialGesture": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_ProductCreditRefund": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_ProductCreditRefundAdjustment": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_ProductCreditRefundCommercialGesture": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_ProductDebit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "promotions": { "type": "array", "description": "The promotions applied to the accounting document line.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_ProductDebit_Promotions" } } }, "required": [ "promotions" ] }, "DR12_Response_200_Data_ProductDebit_Promotions": { "type": "object", "properties": { "deduced_amount": { "type": "number", "format": "with decimals", "description": "The promotion amount deducted for this line." }, "id": { "type": "string", "description": "The promotion identifier." }, "type": { "type": "string", "description": "The promotion type: `ITEM` if applied to this item only, or `BASKET` if applied to every item in the basket for this shop." } }, "required": [ "deduced_amount", "id", "type" ] }, "DR12_Response_200_Data_Product_References": { "type": "object", "properties": { "reference": { "type": "string", "description": "The value of the product reference." }, "type": { "type": "string", "description": "The type of the product reference." } }, "required": [ "reference", "type" ] }, "DR12_Response_200_Data_PurchaseOrderCredit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "required": [ "entity_id", "entity_type", "id", "price_excluding_taxes", "quantity", "shop", "taxes", "total_price_including_taxes", "unit_price_excluding_taxes" ] }, "DR12_Response_200_Data_PurchaseOrderDebit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/DR12_Response_200_Data" } ], "properties": { "promotions": { "type": "array", "description": "The promotions applied to the accounting document line.", "items": { "$ref": "#/components/schemas/DR12_Response_200_Data_PurchaseOrderDebit_Promotions" } } }, "required": [ "promotions" ] }, "DR12_Response_200_Data_PurchaseOrderDebit_Promotions": { "type": "object", "properties": { "deduced_amount": { "type": "number", "format": "with decimals", "description": "The promotion amount deducted for this line." }, "id": { "type": "string", "description": "The promotion identifier." }, "type": { "type": "string", "description": "The promotion type: `ITEM` if applied to this item only, or `BASKET` if applied to every item in the basket for this shop." } }, "required": [ "deduced_amount", "id", "type" ] }, "DR12_Response_200_Data_ShippingFrom": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/DR12_Response_200_Data_ShippingFrom_Address", "description": "The address from where the order line is shipped." } } }, "DR12_Response_200_Data_ShippingFrom_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "The city of the shipping origin address." }, "country_iso_code": { "type": "string", "description": "The ISO 3166-1 alpha-3 country code of the shipping origin address." }, "state": { "type": "string", "description": "The state, province, or region of the shipping origin address." }, "street1": { "type": "string", "description": "The primary line of the shipping origin street address (e.g., street number and name)." }, "street2": { "type": "string", "description": "The secondary line of the shipping origin street address (e.g., building, floor, or suite number)." }, "zip_code": { "type": "string", "description": "The postal or zip code of the shipping origin address." } }, "required": [ "country_iso_code" ] }, "DR12_Response_200_Data_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The tax amount." }, "code": { "type": "string", "description": "The tax code." }, "rate": { "type": "number", "format": "with decimals", "description": "The tax rate." } }, "required": [ "amount", "code" ] }, "DR12_Response_200_Data_ShippingTo": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/DR12_Response_200_Data_ShippingTo_Address", "description": "The address to where the order line is shipped." } } }, "DR12_Response_200_Data_ShippingTo_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "The city of the shipping destination address." }, "civility": { "type": "string", "description": "The civility or title of the recipient (e.g., Mr., Mrs., Dr.)." }, "company": { "type": "string", "description": "The company or organization name of the shipping destination." }, "company2": { "type": "string", "description": "The secondary company or organization name of the shipping destination (e.g., department or subsidiary)." }, "country_iso_code": { "type": "string", "description": "The ISO 3166-1 alpha-3 country code of the shipping destination address." }, "firstname": { "type": "string", "description": "The first name of the recipient." }, "lastname": { "type": "string", "description": "The last name of the recipient." }, "phone": { "type": "string", "description": "The primary phone number of the recipient." }, "phone_secondary": { "type": "string", "description": "The secondary phone number of the recipient." }, "state": { "type": "string", "description": "The state, province, or region of the shipping destination address." }, "street1": { "type": "string", "description": "The primary line of the shipping destination street address (e.g., street number and name)." }, "street2": { "type": "string", "description": "The secondary line of the shipping destination street address (e.g., building, floor, or suite number)." }, "zip_code": { "type": "string", "description": "The postal or zip code of the shipping destination address." } } }, "DR12_Response_200_Data_Shop": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "The shop identifier." } }, "required": [ "id" ] }, "DR12_Response_200_Data_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The tax amount." }, "code": { "type": "string", "description": "The tax code." }, "rate": { "type": "number", "format": "with decimals", "description": "The tax rate." } }, "required": [ "amount", "code" ] }, "DR74_Request_MultipartFormData_DocumentsInput": { "type": "object", "properties": { "requests": { "type": "array", "description": "The details of the files to be uploaded ", "items": { "$ref": "#/components/schemas/DR74_Request_MultipartFormData_DocumentsInput_Requests" } } }, "required": [ "requests" ] }, "DR74_Request_MultipartFormData_DocumentsInput_Requests": { "type": "object", "description": "The details of the files to be uploaded ", "properties": { "document_number": { "type": "string", "description": "The accounting document number" }, "due_date": { "type": "string", "format": "date-time", "description": "The accounting document due date" }, "files": { "type": "array", "description": "The files details for each required format", "items": { "$ref": "#/components/schemas/DR74_Request_MultipartFormData_DocumentsInput_Requests_Files" } }, "issue_date": { "type": "string", "format": "date-time", "description": "The accounting document issue date" }, "request_id": { "type": "string", "description": "The document request identifier on which to upload the document" }, "total_amount_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The total document amount (excluding taxes)" }, "total_tax_amount": { "type": "number", "format": "with decimals", "description": "The total tax amount of the document" } }, "required": [ "document_number", "files", "request_id" ] }, "DR74_Request_MultipartFormData_DocumentsInput_Requests_Files": { "type": "object", "description": "The files details for each required format", "properties": { "format": { "type": "string", "description": "The document format\n\nEnum: `\"PDF\"`, `\"cXML\"`\n" }, "name": { "type": "string", "description": "The document file name" } }, "required": [ "format", "name" ] }, "DR74_Response_200": { "type": "object", "properties": { "requests": { "type": "array", "description": "Details of the documents for each request as they were sent", "items": { "$ref": "#/components/schemas/DR74_Response_200_Requests" } } }, "required": [ "requests" ] }, "DR74_Response_200_Requests": { "type": "object", "properties": { "errors": { "type": "array", "description": "Error if upload failed for the corresponding document", "items": { "$ref": "#/components/schemas/DR74_Response_200_Requests_Errors" } }, "input": { "$ref": "#/components/schemas/DR74_Response_200_Requests_Input", "description": "Reminder of the input API request elements, to help understand possible error messages" } }, "required": [ "input" ] }, "DR74_Response_200_Requests_Errors": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "field": { "type": "string", "description": "Name of the field on the input object" }, "message": { "type": "string", "description": "Error message" } }, "required": [ "code", "field", "message" ] }, "DR74_Response_200_Requests_Input": { "type": "object", "properties": { "document_number": { "type": "string", "description": "The accounting document number" }, "due_date": { "type": "string", "format": "date-time", "description": "The accounting document due date" }, "files": { "type": "array", "description": "The files details for each required format", "items": { "$ref": "#/components/schemas/DR74_Response_200_Requests_Input_Files" } }, "issue_date": { "type": "string", "format": "date-time", "description": "The accounting document issue date" }, "request_id": { "type": "string", "description": "The document request identifier on which to upload the document" }, "total_amount_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The total document amount (excluding taxes)" }, "total_tax_amount": { "type": "number", "format": "with decimals", "description": "The total tax amount of the document" } }, "required": [ "document_number", "files", "request_id" ] }, "DR74_Response_200_Requests_Input_Files": { "type": "object", "properties": { "format": { "type": "string", "description": "The document format\n\nEnum: `\"PDF\"`, `\"cXML\"`\n" }, "name": { "type": "string", "description": "The document file name" } }, "required": [ "format", "name" ] }, "DR75_Request": { "type": "object", "properties": { "requests": { "type": "array", "description": "The details of the accounting documents issuance to confirm.", "items": { "$ref": "#/components/schemas/DR75_Request_Requests" }, "maxItems": 100, "minItems": 1 } }, "required": [ "requests" ] }, "DR75_Request_Requests": { "type": "object", "description": "The details of the accounting documents issuance to confirm.", "properties": { "document_number": { "type": "string", "description": "The accounting document number" }, "due_date": { "type": "string", "format": "date-time", "description": "The accounting document due date" }, "issue_date": { "type": "string", "format": "date-time", "description": "The accounting document issue date" }, "request_id": { "type": "string", "description": "The document request identifier for which to confirm issuance" }, "total_amount_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The total document amount (excluding taxes)" }, "total_tax_amount": { "type": "number", "format": "with decimals", "description": "The total tax amount of the document" } }, "required": [ "document_number", "request_id" ] }, "DR75_Response_200": { "type": "object", "properties": { "requests": { "type": "array", "description": "Details of the documents for each request as they were sent", "items": { "$ref": "#/components/schemas/DR75_Response_200_Requests" } } }, "required": [ "requests" ] }, "DR75_Response_200_Requests": { "type": "object", "properties": { "errors": { "type": "array", "description": "Error if the issuance confirmation failed for the corresponding document", "items": { "$ref": "#/components/schemas/DR75_Response_200_Requests_Errors" } }, "input": { "$ref": "#/components/schemas/DR75_Response_200_Requests_Input", "description": "Reminder of the input API request elements, to help understand possible error messages" } }, "required": [ "input" ] }, "DR75_Response_200_Requests_Errors": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code" }, "field": { "type": "string", "description": "Name of the field on the input object" }, "message": { "type": "string", "description": "Error message" } }, "required": [ "code", "field", "message" ] }, "DR75_Response_200_Requests_Input": { "type": "object", "properties": { "document_number": { "type": "string", "description": "The accounting document number" }, "due_date": { "type": "string", "format": "date-time", "description": "The accounting document due date" }, "issue_date": { "type": "string", "format": "date-time", "description": "The accounting document issue date" }, "request_id": { "type": "string", "description": "The document request identifier for which to confirm issuance" }, "total_amount_excluding_taxes": { "type": "number", "format": "with decimals", "description": "The total document amount (excluding taxes)" }, "total_tax_amount": { "type": "number", "format": "with decimals", "description": "The total tax amount of the document" } }, "required": [ "document_number", "request_id" ] }, "H11_Response_200": { "type": "object", "properties": { "hierarchies": { "type": "array", "description": "List of hierarchies", "items": { "$ref": "#/components/schemas/H11_Response_200_Hierarchies" } } }, "required": [ "hierarchies" ] }, "H11_Response_200_Hierarchies": { "type": "object", "properties": { "code": { "type": "string", "description": "Hierarchy code" }, "label": { "type": "string", "description": "Hierarchy label" }, "label_translations": { "type": "array", "description": "Hierarchy label translation", "items": { "$ref": "#/components/schemas/H11_Response_200_Hierarchies_LabelTranslations" } }, "level": { "type": "integer", "format": "int32", "description": "Hierarchy level" }, "parent_code": { "type": "string", "description": "Parent Hierarchy code" } }, "required": [ "code", "label_translations", "level", "parent_code" ] }, "H11_Response_200_Hierarchies_LabelTranslations": { "type": "object", "properties": { "locale": { "type": "string", "description": "Locale" }, "value": { "type": "string", "description": "Translation" } } }, "IV01_Response_200": { "type": "object", "properties": { "invoices": { "type": "array", "description": "Accounting documents", "items": { "$ref": "#/components/schemas/IV01_Response_200_Invoices" } }, "total_count": { "type": "integer", "format": "int64", "description": "Accounting documents total count" } } }, "IV01_Response_200_Invoices": { "type": "object", "discriminator": { "mapping": { "AUTO_INVOICE": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice", "MANUAL_CREDIT": "#/components/schemas/IV01_Response_200_Invoices_ManualCredit", "MANUAL_INVOICE": "#/components/schemas/IV01_Response_200_Invoices_ManualInvoice" }, "propertyName": "type" }, "properties": { "currency_iso_code": { "type": "string", "description": "The currency of the shop\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date_created": { "type": "string", "format": "date-time", "description": "Accounting document creation date" }, "details": { "type": "array", "description": "Accounting details", "items": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_Details" } }, "due_date": { "type": "string", "format": "date-time", "description": "Due date for the payment of the accounting document" }, "id": { "type": "string", "description": "Accounting document identifier (use it for draft document)" }, "invoice_id": { "type": "integer", "format": "int64", "description": "Accounting document identifier (present if the accounting document is issued)" }, "issue_date": { "type": "string", "format": "date-time", "description": "Issue date of an accounting document" }, "issuing_user": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_IssuingUser", "description": "Accounting document issuing user" }, "pay_out_psp_code": { "type": "string", "description": "PSP code for Pay-out\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" }, "payment": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_Payment", "description": "Accounting document payment details" }, "shop_address": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_ShopAddress", "description": "Shop address" }, "shop_corporate_name": { "type": "string", "description": "Shop corporate name if it is a professional shop" }, "shop_id": { "type": "integer", "format": "int64", "description": "Shop id" }, "shop_model": { "type": "string", "description": "Shop model\n\nEnum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n" }, "shop_name": { "type": "string", "description": "Shop name" }, "shop_operator_internal_id": { "type": "string", "description": "Operator internal id for the shop" }, "shop_tax_number": { "type": "string", "description": "Shop tax number if it is a professional shop" }, "state": { "type": "string", "description": "Accounting document state" }, "total_amount_excl_taxes": { "type": "number", "format": "with decimals", "description": "Total amount charged to the shop (excluding taxes)" }, "total_amount_incl_taxes": { "type": "number", "format": "with decimals", "description": "Total amount charged to the shop (including taxes)" }, "total_charged_amount": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Use “total_amount_incl_taxes” attribute instead" }, "total_taxes": { "type": "array", "description": "Total taxes", "items": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_TotalTaxes" } }, "type": { "type": "string", "description": "Accounting document type\n\nEnum: `\"ALL\"`, `\"AUTO_INVOICE\"`, `\"MANUAL_INVOICE\"`, `\"MANUAL_CREDIT\"`\n" } } }, "IV01_Response_200_Invoices_AutoInvoice": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices" } ], "description": "Automatic accounting document", "properties": { "end_time": { "type": "string", "format": "date-time", "description": "Ending date of the period for accounting document of type AUTO_INVOICE" }, "payment_info": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo", "description": "Shop payment information" }, "seller_billing_cycle_id": { "type": "string", "description": "The seller billing cycle identifier" }, "start_time": { "type": "string", "format": "date-time", "description": "Starting date of the period for accounting document of type AUTO_INVOICE" }, "summary": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_Summary", "description": "Summary for automatic accounting document" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo": { "type": "object", "discriminator": { "mapping": { "ABA": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba", "AUBSB": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb", "BRAZILIAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian", "CANADIAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian", "COLOMBIAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian", "GUATEMALAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan", "HK": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk", "IBAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban", "INDIAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian", "ISRAELI": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli", "JAPANESE": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese", "MEXICAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican", "NUBAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban", "NZBSB": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb", "PAYOUT": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout", "PHILIPPINES": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines", "SERBIAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian", "SG": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg", "TAIWANESE": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese", "THAI": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai", "UK": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk", "URUGUAYAN": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan", "VIETNAMESE": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese" }, "propertyName": "type" }, "properties": { "@type": { "type": "string", "description": "Enum: `\"IBAN\"`, `\"NUBAN\"`, `\"AUBSB\"`, `\"NZBSB\"`, `\"ABA\"`, `\"HK\"`, `\"CANADIAN\"`, `\"MEXICAN\"`, `\"JAPANESE\"`, `\"BRAZILIAN\"`, `\"TAIWANESE\"`, `\"THAI\"`, `\"INDIAN\"`, `\"UK\"`, `\"URUGUAYAN\"`, `\"COLOMBIAN\"`, `\"SG\"`, `\"PHILIPPINES\"`, `\"PAYOUT\"`, `\"ISRAELI\"`, `\"VIETNAMESE\"`, `\"GUATEMALAN\"`, `\"SERBIAN\"`\n" }, "bank_city": { "type": "string", "description": "Bank city" }, "bank_name": { "type": "string", "description": "Bank name" }, "bank_street": { "type": "string", "description": "Bank street name" }, "bank_zip": { "type": "string", "description": "Bank zip code" }, "owner": { "type": "string", "description": "Name of the owner of the payment information" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank Account Number" }, "bic": { "type": "string", "description": "Bank account BIC code (aka Swift Code)" }, "routing_number": { "type": "string", "description": "Routing Number of the bank, (aka ABA code)" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "auban": { "type": "string", "description": "Bank account number" }, "aubsb": { "type": "string", "description": "Bank state branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" }, "bank_account_type": { "type": "string", "description": "Account type\n
\n\n\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_code": { "type": "string", "description": "Bank code" }, "branch_code": { "type": "string", "description": "Branch code" }, "pix_key": { "type": "string", "description": "Pix key" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number" }, "institution_number": { "type": "string", "description": "Bank institution number" }, "swift_code": { "type": "string", "description": "Bank account swift code" }, "transit_number": { "type": "string", "description": "Bank transit number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" }, "bank_account_type": { "type": "string", "description": "Account type\n
\n\n\n\nEnum: `\"C\"`, `\"P\"`\n" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" }, "bank_account_type": { "type": "string", "description": "Account type\n
\n\n\n\nEnum: `\"C\"`, `\"P\"`\n" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number" }, "swift_code": { "type": "string", "description": "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bic": { "type": "string", "description": "Bank account BIC code" }, "iban": { "type": "string", "description": "Bank account IBAN" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" }, "indian_financial_system_code": { "type": "string", "description": "Indian financial system code" }, "swift_code": { "type": "string", "description": "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Account number" }, "bank_code": { "type": "string", "description": "Bank code" }, "branch_name": { "type": "string", "description": "Branch name" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number" }, "bank_account_type": { "type": "string", "description": "Account type\n
\n\n\n\nEnum: `\"C\"`, `\"P\"`\n" }, "bank_code": { "type": "string", "description": "Bank code" }, "branch_code": { "type": "string", "description": "Branch code" }, "branch_name": { "type": "string", "description": "Branch name" }, "swift_code": { "type": "string", "description": "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number" }, "clabe": { "type": "string", "description": "Clave Bancaria Estandarizada" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "nuban": { "type": "string", "description": "The bank account NUBAN code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "nzban": { "type": "string", "description": "Bank Account Number" }, "nzbsb": { "type": "string", "description": "Bank State Branch code." } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Account number" }, "bic": { "type": "string", "description": "BIC" }, "iban": { "type": "string", "description": "IBAN" }, "payout_format": { "type": "string", "description": "Payout format\n\nEnum: `\"LOCAL_IBAN\"`, `\"LOCAL_UK\"`, `\"INTERNATIONAL\"`\n" }, "sort_code": { "type": "string", "description": "Sort code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Account number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Bank account number" }, "bank_branch_number": { "type": "string", "description": "Bank branch number" }, "bic": { "type": "string", "description": "Bank account BIC code" }, "iban": { "type": "string", "description": "Bank account IBAN" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Account number" }, "bank_key": { "type": "string", "description": "Bank key" }, "swift_code": { "type": "string", "description": "Swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" }, "bank_code": { "type": "string", "description": "Bank code" }, "branch_code": { "type": "string", "description": "Branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Account number" }, "sort_code": { "type": "string", "description": "Sort code" }, "swift_code": { "type": "string", "description": "Swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "account_number": { "type": "string", "description": "Account number" }, "bank_account_type": { "type": "string", "description": "Account type\n
\n\n\n\nEnum: `\"C\"`, `\"P\"`\n" }, "branch_code": { "type": "string", "description": "Branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties": { "bank_account_number": { "type": "string", "description": "Account number" }, "branch_name": { "type": "string", "description": "Branch name" } } }, "IV01_Response_200_Invoices_AutoInvoice_Summary": { "type": "object", "properties": { "amount_transferred": { "type": "number", "format": "with decimals", "description": "Total amount to be transferred to the seller" }, "amount_transferred_to_operator": { "type": "number", "format": "with decimals", "description": "Total amount to be transferred to the operator" }, "reserve_funding": { "type": "number", "format": "with decimals", "description": "Amount set aside for the seller reserve" }, "reserve_settlement": { "type": "number", "format": "with decimals", "description": "Amount paid out from the seller reserve" }, "total_commissions_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of commissions (excluding taxes on orders)" }, "total_commissions_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of commissions (including taxes on orders)" }, "total_fee_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees (excluding taxes on orders)" }, "total_fee_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees (including taxes on orders)" }, "total_fee_operator_remitted_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees remitted by the operator (excluding taxes on orders)" }, "total_fee_operator_remitted_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees remitted by the operator (including taxes on orders)" }, "total_mirakl_ads_credit_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads credits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_credit_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads credits of a payment cycle (including taxes on stores)" }, "total_mirakl_ads_debit_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads debits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_debit_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads debits of a payment cycle (including taxes on stores)" }, "total_non_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_non_payable_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for non payable orders (including shipping charges and taxes on orders)" }, "total_operator_paid_shipping_charges_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of shipping charges paid by the operator (excluding taxes on orders)" }, "total_operator_paid_shipping_charges_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of shipping charges paid by the operator (including taxes on orders)" }, "total_operator_remitted_taxes": { "type": "number", "format": "with decimals", "description": "Total amount for order taxes remitted by the operator" }, "total_other_credits_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual credits of a payment cycle (excluding taxes on stores)" }, "total_other_credits_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual credits of a payment cycle (including taxes on stores)" }, "total_other_invoices_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual invoices of a payment cycle (excluding taxes on stores)" }, "total_other_invoices_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual invoices of a payment cycle (including taxes on stores)" }, "total_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for payable orders including shipping charges (excluding taxes on orders)" }, "total_payable_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for payable orders including taxes (including taxes on orders)" }, "total_purchase_taxes": { "type": "number", "format": "with decimals", "description": "Total amount for purchase taxes" }, "total_refund_commissions_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded commissions (excluding taxes on orders)" }, "total_refund_commissions_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded commissions (including taxes on orders)" }, "total_refund_fee_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees (excluding taxes on orders)" }, "total_refund_fee_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees (including taxes on orders)" }, "total_refund_fee_operator_remitted_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees remitted by the operator (excluding taxes on orders)" }, "total_refund_fee_operator_remitted_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees remitted by the operator (including taxes on orders)" }, "total_refund_non_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "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", "format": "with decimals", "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", "format": "with decimals", "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", "format": "with decimals", "description": "Total amount of refunded shipping charges paid by the operator (including taxes on orders)" }, "total_refund_operator_remitted_taxes": { "type": "number", "format": "with decimals", "description": "Total amount of refunded taxes remitted by the operator" }, "total_refund_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded orders (excluding all refunded taxes)" }, "total_refund_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded orders (including all refunded taxes)" }, "total_refund_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount refunded for payable orders (excluding taxes on orders)" }, "total_refund_payable_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount refunded for payable orders (including taxes on orders)" }, "total_refund_purchase_taxes": { "type": "number", "format": "with decimals", "description": "Total amount of refunded purchase taxes" }, "total_seller_fees_on_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller fees on orders (excluding taxes on orders)" }, "total_seller_fees_on_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller fees on orders (including taxes on orders)" }, "total_seller_penalty_fees_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller penalty fees (excluding taxes on orders)" }, "total_seller_penalty_fees_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller penalty fees (including taxes on orders)" }, "total_subscription_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of subscription fees (excluding taxes on stores)" }, "total_subscription_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of subscription taxes (including taxes on stores)" } } }, "IV01_Response_200_Invoices_Details": { "type": "object", "properties": { "amount_excl_taxes": { "type": "number", "format": "with decimals", "description": "Amount excluding taxes" }, "description": { "type": "string", "description": "Description" }, "operation_date": { "type": "string", "format": "date-time", "description": "Operation date for MANUAL_INVOICE or MANUAL_CREDIT type" }, "order_id": { "type": "string", "description": "Associated order id. Only for MANUAL_INVOICE or MANUAL_CREDIT type" }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity" }, "taxes": { "type": "array", "description": "Taxes", "items": { "$ref": "#/components/schemas/IV01_Response_200_Invoices_Details_Taxes" } } } }, "IV01_Response_200_Invoices_Details_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "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)\n\nEnum: `\"OPERATOR\"`, `\"BATCH\"`, `\"PARTNER\"`\n" } } }, "IV01_Response_200_Invoices_ManualCredit": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/IV01_Response_200_Invoices" } ], "description": "Manual accounting document", "properties": { "emission_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "Emission date for accounting document of type MANUAL_INVOICE or MANUAL_CREDIT" }, "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": { "emission_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "Emission date for accounting document of type MANUAL_INVOICE or MANUAL_CREDIT" }, "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\n\nEnum: `\"INCOMPLETE_KYC\"`, `\"AWAITING_INVOICE_CHECK\"`\n" }, "reference": { "type": "string", "description": "Transaction reference" }, "state": { "type": "string", "description": "Payment status\n\nEnum: `\"PENDING\"`, `\"PAID\"`, `\"FAILED\"`\n" }, "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" }, "company": { "type": "string", "deprecated": true, "description": "Shop contact company name" }, "complementary": { "type": "string", "deprecated": true, "description": "Shop contact complementary address field" }, "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", "format": "with decimals", "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" } } }, "required": [ "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" } }, "required": [ "code", "label" ] }, "M01_Response_200": { "type": "object", "properties": { "messages": { "type": "array", "description": "List of messages", "items": { "$ref": "#/components/schemas/M01_Response_200_Messages" } }, "total_count": { "type": "integer", "format": "int32", "description": "Messages total count" } }, "required": [ "messages", "total_count" ] }, "M01_Response_200_Messages": { "type": "object", "properties": { "archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "body": { "type": "string", "description": "Message body" }, "commercial_id": { "type": "string", "description": "Order commercial ID. Used only when retrieving messages of an order." }, "date_created": { "type": "string", "format": "date-time", "description": "Message creation date" }, "documents": { "type": "array", "description": "Documents list", "items": { "$ref": "#/components/schemas/M01_Response_200_Messages_Documents" } }, "from_id": { "type": "string", "description": "Sender user identifier" }, "from_name": { "type": "string", "description": "Sender user name" }, "from_type": { "type": "string", "description": "Sender user type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" }, "id": { "type": "integer", "format": "int64", "description": "Message identifier" }, "offer_id": { "type": "integer", "format": "int64", "description": "Identifier of offer : this value is not fixed and can changed after a long period" }, "order_id": { "type": "string", "description": "Order ID. Used only when retrieving messages of an order." }, "read": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "subject": { "type": "string", "description": "Message subject" }, "to_customer_archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "to_customer_id": { "type": "string", "description": "Recipient customer ID" }, "to_customer_name": { "type": "string", "description": "Recipient customer name" }, "to_operator": { "type": "boolean", "description": "Indicates the message sent to operator. Used only when retrieving messages of an order." }, "to_operator_archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "to_shop_archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "to_shop_id": { "type": "integer", "format": "int64", "description": "Recipient shop ID" }, "to_shop_name": { "type": "string", "description": "Recipient shop name" }, "visible": { "type": "boolean", "deprecated": true, "description": "States whether or not the message is visible (public). Only relevant for messages on offers and always null for messages on orders." } }, "required": [ "body", "commercial_id", "date_created", "from_id", "from_name", "from_type", "id", "subject", "to_customer_archived", "to_customer_id", "to_customer_name", "to_operator", "to_operator_archived", "to_shop_archived", "to_shop_id", "to_shop_name" ] }, "M01_Response_200_Messages_Documents": { "type": "object", "properties": { "date_uploaded": { "type": "string", "format": "date-time", "description": "Document uploaded date" }, "file_name": { "type": "string", "description": "Document file name" }, "file_size": { "type": "integer", "format": "int64", "description": "File size" }, "id": { "type": "integer", "format": "int64", "description": "Document identifier" }, "type": { "type": "string", "description": "Document type code" } }, "required": [ "file_name", "id", "type" ] }, "M10_Response_200": { "type": "object", "properties": { "authorized_participants": { "type": "array", "description": "Thread authorized participants
\nThose are the participants who are authorized to join the thread.\n", "items": { "$ref": "#/components/schemas/M10_Response_200_AuthorizedParticipants" } }, "current_participants": { "type": "array", "description": "Thread current participants
\nThose are the participants who have actually participated in the thread, meaning that they are either sender or receivers of at least one message of the thread.
\nThese participants must be on the list of the authorized_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" } }, "required": [ "authorized_participants", "current_participants", "date_created", "date_updated", "id", "messages", "metadata", "topic" ] }, "M10_Response_200_AuthorizedParticipants": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "type" ] }, "M10_Response_200_CurrentParticipants": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "type" ] }, "M10_Response_200_CustomerOrganization": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Customer organization name" }, "id": { "type": "string", "description": "Customer organization id" } }, "required": [ "display_name", "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" } }, "required": [ "id", "label", "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" } } }, "required": [ "body", "date_created", "from", "id", "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" } }, "required": [ "id", "name", "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\n\nEnum: `\"OPERATOR_USER\"`, `\"SHOP_USER\"`, `\"CUSTOMER_USER\"`\n" } }, "required": [ "display_name", "type" ] }, "M10_Response_200_Messages_From_OrganizationDetails": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "type" ] }, "M10_Response_200_Messages_To": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "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" } }, "required": [ "last_message_date", "last_sender", "shop_reply_needed_since", "total_count" ] }, "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\n\nEnum: `\"OPERATOR_USER\"`, `\"SHOP_USER\"`, `\"CUSTOMER_USER\"`\n" } }, "required": [ "display_name", "type" ] }, "M10_Response_200_Metadata_LastSender_OrganizationDetails": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "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\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`\n" } }, "required": [ "date", "user_type" ] }, "M10_Response_200_Topic": { "type": "object", "properties": { "type": { "type": "string", "description": "Topic type\n\nEnum: `\"FREE_TEXT\"`, `\"REASON_CODE\"`\n" }, "value": { "type": "string", "description": "Topic value" } }, "required": [ "type", "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." } }, "required": [ "data" ] }, "M11_Response_200_Data": { "type": "object", "properties": { "authorized_participants": { "type": "array", "description": "Thread authorized participants
\nThose are the participants who are authorized to join the thread.\n", "items": { "$ref": "#/components/schemas/M11_Response_200_Data_AuthorizedParticipants" } }, "current_participants": { "type": "array", "description": "Thread current participants
\nThose are the participants who have actually participated in the thread, meaning that they are either sender or receivers of at least one message of the thread.
\nThese participants must be on the list of the authorized_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" } }, "required": [ "authorized_participants", "current_participants", "date_created", "date_updated", "id", "metadata", "topic" ] }, "M11_Response_200_Data_AuthorizedParticipants": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "type" ] }, "M11_Response_200_Data_CurrentParticipants": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "type" ] }, "M11_Response_200_Data_CustomerOrganization": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Customer organization name" }, "id": { "type": "string", "description": "Customer organization id" } }, "required": [ "display_name", "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" } }, "required": [ "id", "label", "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" } } }, "required": [ "body", "date_created", "from", "id", "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" } }, "required": [ "id", "name", "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\n\nEnum: `\"OPERATOR_USER\"`, `\"SHOP_USER\"`, `\"CUSTOMER_USER\"`\n" } }, "required": [ "display_name", "type" ] }, "M11_Response_200_Data_Messages_From_OrganizationDetails": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "type" ] }, "M11_Response_200_Data_Messages_To": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "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" } }, "required": [ "last_message_date", "last_sender", "shop_reply_needed_since", "total_count" ] }, "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\n\nEnum: `\"OPERATOR_USER\"`, `\"SHOP_USER\"`, `\"CUSTOMER_USER\"`\n" } }, "required": [ "display_name", "type" ] }, "M11_Response_200_Data_Metadata_LastSender_OrganizationDetails": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Participant display name" }, "id": { "type": "string", "description": "Participant id
When type equals OPERATOR, no id will be returned." }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "display_name", "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\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`\n" } }, "required": [ "date", "user_type" ] }, "M11_Response_200_Data_Topic": { "type": "object", "properties": { "type": { "type": "string", "description": "Topic type\n\nEnum: `\"FREE_TEXT\"`, `\"REASON_CODE\"`\n" }, "value": { "type": "string", "description": "Topic value" } }, "required": [ "type", "value" ] }, "M12_Request_MultipartFormData_MessageInput": { "type": "object", "properties": { "body": { "type": "string", "description": "Message body", "maxLength": 50000, "minLength": 3 }, "to": { "type": "array", "description": "List of recipients of the message", "items": { "$ref": "#/components/schemas/M12_Request_MultipartFormData_MessageInput_To" } }, "topic": { "$ref": "#/components/schemas/M12_Request_MultipartFormData_MessageInput_Topic", "description": "New topic for the thread. Leave empty if you don't want to update it." } }, "required": [ "body", "to" ] }, "M12_Request_MultipartFormData_MessageInput_To": { "type": "object", "description": "List of recipients of the message", "properties": { "id": { "type": "string", "description": "Participant id" }, "type": { "type": "string", "description": "Participant type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "required": [ "type" ] }, "M12_Request_MultipartFormData_MessageInput_Topic": { "type": "object", "description": "New topic for the thread. Leave empty if you don't want to update it.", "discriminator": { "mapping": { "FREE_TEXT": "#/components/schemas/M12_Request_MultipartFormData_MessageInput_Topic_FreeText", "REASON_CODE": "#/components/schemas/M12_Request_MultipartFormData_MessageInput_Topic_ReasonCode" }, "propertyName": "type" }, "properties": { "type": { "type": "string", "description": "Enum: `\"FREE_TEXT\"`, `\"REASON_CODE\"`\n" }, "value": { "type": "string" } } }, "M12_Request_MultipartFormData_MessageInput_Topic_FreeText": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/M12_Request_MultipartFormData_MessageInput_Topic" } ], "properties": { "value": { "type": "string", "description": "Topic value", "maxLength": 200, "minLength": 3 } }, "required": [ "value" ] }, "M12_Request_MultipartFormData_MessageInput_Topic_ReasonCode": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/M12_Request_MultipartFormData_MessageInput_Topic" } ], "properties": { "value": { "type": "string", "description": "Code of the reason", "maxLength": 200, "minLength": 1 } }, "required": [ "value" ] }, "M12_Response_201": { "type": "object", "properties": { "message_id": { "type": "string", "description": "Id of the message" }, "thread_id": { "type": "string", "description": "Id of the thread" } } }, "M14_Request_MultipartFormData_ThreadInput": { "type": "object", "properties": { "body": { "type": "string", "description": "Message body", "maxLength": 50000, "minLength": 3 }, "entity": { "$ref": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput_Entity", "description": "Entity related to the thread" }, "topic": { "$ref": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput_Topic", "description": "Topic of the thread" } }, "required": [ "body", "entity", "topic" ] }, "M14_Request_MultipartFormData_ThreadInput_Entity": { "type": "object", "description": "Entity related to the thread", "properties": { "type": { "type": "string", "description": "Entity type" } }, "required": [ "type" ] }, "M14_Request_MultipartFormData_ThreadInput_Topic": { "type": "object", "description": "Topic of the thread", "discriminator": { "mapping": { "FREE_TEXT": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput_Topic_FreeText", "REASON_CODE": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput_Topic_ReasonCode" }, "propertyName": "type" }, "properties": { "type": { "type": "string", "description": "Enum: `\"FREE_TEXT\"`, `\"REASON_CODE\"`\n" }, "value": { "type": "string" } } }, "M14_Request_MultipartFormData_ThreadInput_Topic_FreeText": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput_Topic" } ], "properties": { "value": { "type": "string", "description": "Topic value", "maxLength": 200, "minLength": 3 } }, "required": [ "value" ] }, "M14_Request_MultipartFormData_ThreadInput_Topic_ReasonCode": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput_Topic" } ], "properties": { "value": { "type": "string", "description": "Code of the reason", "maxLength": 200, "minLength": 1 } }, "required": [ "value" ] }, "M14_Response_201": { "type": "object", "properties": { "message_id": { "type": "string", "description": "Id of the message" }, "thread_id": { "type": "string", "description": "Id of the thread" } } }, "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" } }, "required": [ "import_id" ] }, "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\n\nEnum: `\"NORMAL\"`, `\"REPLACE\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"PARTIAL_UPDATE\"`\n
\n" }, "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\n\nEnum: `\"WAITING_SYNCHRONIZATION_PRODUCT\"`, `\"WAITING\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"FAILED\"`\n" }, "type": { "type": "string", "deprecated": true, "description": "Will be remove in a future version\n\nEnum: `\"AUTO\"`, `\"MIRAKL\"`, `\"AMAZON\"`\n" } }, "required": [ "date_created", "has_error_report", "import_id", "lines_in_error", "lines_in_pending", "lines_in_success", "lines_read", "mode", "offer_deleted", "offer_inserted", "offer_updated", "reason_status", "status", "type" ] }, "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." } }, "required": [ "data" ] }, "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\n\nEnum: `\"NORMAL\"`, `\"REPLACE\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"PARTIAL_UPDATE\"`\n
\n" }, "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\n\nEnum: `\"API\"`, `\"FTP\"`, `\"SFTP\"`, `\"HTTP\"`, `\"HTTPS\"`, `\"FRONT\"`, `\"PENDING_OFFERS\"`\n" }, "reason_status": { "type": "string", "description": "Import status reason" }, "shop_id": { "type": "integer", "format": "int64", "description": "Shop identifier" }, "status": { "type": "string", "description": "Import status\n\nEnum: `\"WAITING_SYNCHRONIZATION_PRODUCT\"`, `\"WAITING\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"FAILED\"`\n" } }, "required": [ "date_created", "has_error_report", "import_id", "lines_in_error", "lines_in_pending", "lines_in_success", "lines_read", "mode", "offer_deleted", "offer_inserted", "offer_updated", "origin", "shop_id", "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" } }, "required": [ "offers", "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\n
\nFor Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices\n", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_AllPrices" } }, "allow_quote_requests": { "type": "boolean", "description": "Whether the offer is eligible for quotation" }, "applicable_pricing": { "$ref": "#/components/schemas/OF21_Response_200_Offers_ApplicablePricing", "description": "Pricing defined for the offer, including the prices for the selected channel if available\n
\nFor Dropship specifically: the list of applicable purchasing prices of the offer, also referred to as costs or wholesale prices.\n" }, "available_end_date": { "type": "string", "format": "date-time", "description": "Available end date" }, "available_start_date": { "type": "string", "format": "date-time", "description": "Available start date" }, "category_code": { "type": "string", "description": "Product category code" }, "category_label": { "type": "string", "description": "Product category label " }, "channels": { "type": "array", "description": "List of channel codes on which the offer can be sold", "items": { "type": "string" }, "uniqueItems": true }, "currency_iso_code": { "type": "string", "description": "The currency of the shop (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "description": { "type": "string", "description": "Offer description" }, "discount": { "$ref": "#/components/schemas/OF21_Response_200_Offers_Discount", "deprecated": true, "description": "

Discount of the offer

Please use 'applicablePricing' instead

" }, "eco_contributions": { "type": "array", "description": "Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_EcoContributions" }, "maxItems": 20 }, "favorite_rank": { "type": "integer", "format": "int32", "description": "Favorite rank for the offer, when the favorite feature is enabled and the offer is a favorite" }, "fulfillment": { "$ref": "#/components/schemas/OF21_Response_200_Offers_Fulfillment", "description": "Fulfillment information" }, "inactivity_reasons": { "type": "array", "description": "Reasons for offers inactivity, mandatory if an offer is inactive", "items": { "type": "string", "description": "Enum: `\"PRODUCT_STATUS_NEW\"`, `\"PRODUCT_STATUS_INVALID\"`, `\"PRODUCT_STATUS_REJECTED\"`, `\"PRODUCT_STATUS_UNAUTHORIZED_TO_SELL\"`, `\"PRODUCT_STATUS_PENDING\"`, `\"PRODUCT_STATUS_SYNCHRO_ERROR\"`, `\"PRODUCT_DISABLED\"`, `\"SHOP_NOT_OPEN\"`, `\"ZERO_QUANTITY\"`, `\"NO_MIN_SHIPPING_RATE\"`, `\"NOT_IN_AVAILABILITY_PERIOD\"`, `\"NO_CHANNEL_ON_SHOP\"`, `\"SHOP_CURRENCY_DISABLED\"`, `\"AVAILABLE_QUANTITY_LESS_THAN_MIN_ORDER_QUANTITY\"`, `\"AVAILABLE_QUANTITY_LESS_THAN_PACKAGE_QUANTITY\"`, `\"NO_ACTIVE_PRICE\"`, `\"CATEGORY_UNAUTHORIZED_TO_SELL\"`, `\"BRAND_UNAUTHORIZED_TO_SELL\"`, `\"OFFER_STATE_UNAUTHORIZED_TO_SELL\"`\n" } }, "internal_description": { "type": "string", "description": "The offer's description as shown in the back office" }, "leadtime_to_ship": { "type": "integer", "format": "int32", "description": "Offer's lead time to ship value. If this value has been set to 0, value is returned as 1 (unless platform's default lead time to ship value is also 0). If no lead time to ship was specified for the offer, platform's default value is returned." }, "logistic_class": { "$ref": "#/components/schemas/OF21_Response_200_Offers_LogisticClass", "description": "The logistic class associated to the offer" }, "max_order_quantity": { "type": "integer", "format": "int32", "description": "Highest quantity of product items per order" }, "min_order_quantity": { "type": "integer", "format": "int32", "description": "Lowest quantity of product items per order" }, "min_quantity_alert": { "type": "integer", "format": "int32", "description": "Mininum quantity of the offer" }, "min_shipping_price": { "type": "number", "format": "with decimals", "description": "Unit price of the minimum shipping rate" }, "min_shipping_price_additional": { "type": "number", "format": "with decimals", "description": "Additional unit price associated to the minimum shipping rate" }, "min_shipping_type": { "type": "string", "description": "Code of the shipping type associated to the minimum shipping rate" }, "min_shipping_zone": { "type": "string", "description": "Code of the shipping zone associated to the minimum shipping rate" }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).\n
\nApplicable only for Dropship offers.\n" }, "offer_additional_fields": { "type": "array", "description": "Custom fields of the offer", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } }, "offer_id": { "type": "integer", "format": "int64", "description": "Identifier of the offer" }, "package_quantity": { "type": "integer", "format": "int32", "description": "Indivisible quantity of the same product" }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer\n
\nFor Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price\n" }, "price_additional_info": { "type": "string", "description": "Additional price information for the offer" }, "product_brand": { "type": "string", "description": "Brand of the product" }, "product_description": { "type": "string", "description": "Description of the product" }, "product_references": { "type": "array", "description": "Product references", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_ProductReferences" } }, "product_sku": { "type": "string", "description": "Product SKU" }, "product_tax_code": { "type": "string", "description": "Offer product tax code" }, "product_title": { "type": "string", "description": "Product title" }, "quantity": { "type": "integer", "format": "int32", "description": "Available quantity of the offer" }, "retail_prices": { "type": "array", "description": "List retail prices for the offer, also referred to as selling prices.\n
\nApplicable only for Dropship offers.\n", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_RetailPrices" } }, "shipping_deadline": { "type": "string", "format": "date-time", "description": "Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers" }, "shop_sku": { "type": "string", "description": "The offer's shop SKU" }, "state_code": { "type": "string", "description": "Offer condition" }, "total_price": { "type": "number", "format": "with decimals", "description": "Total price of the offer (price + minimum shipping rate)\n
\nFor Dropship specifically: the purchasing price of the offer + minimum shipping rate\n" }, "warehouses": { "type": "array", "description": "The breakdown of the available quantities of the offer in each warehouse.", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_Warehouses" } } }, "required": [ "active", "all_prices", "category_code", "category_label", "channels", "currency_iso_code", "description", "fulfillment", "leadtime_to_ship", "logistic_class", "max_order_quantity", "min_order_quantity", "min_quantity_alert", "min_shipping_price", "min_shipping_price_additional", "min_shipping_type", "min_shipping_zone", "offer_id", "package_quantity", "product_references", "product_sku", "product_title", "quantity", "shipping_deadline", "shop_sku", "state_code" ] }, "OF21_Response_200_Offers_AllPrices": { "type": "object", "properties": { "channel_code": { "type": "string", "deprecated": true, "description": " Single Channel Pricing users: The channel code on which a specific price applies.\n This is the pricing_channel_code supplied as input in the API if prices are defined for this channel.\n If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices.\n channel_code is set to null for the default prices. Multi Channel Pricing users: returned null.\n Refer to context > channel_codes in order to retrieve the channel codes for which the price apply.\n" }, "context": { "$ref": "#/components/schemas/OF21_Response_200_Offers_AllPrices_Context", "description": "The context is not returned for default prices.\n" }, "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer.\n
\nFor Dropship specifically: the purchasing price of the offer\n
\nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
\nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount price for a quantity of one, i.e. the discount price for a quantity of one.\n
\nFor Dropship specifically: the discount purchasing price for a quantity of one\n
\nSet to null if no discount is defined or if no discount price for a quantity of one is defined.\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts.\n
\nFor Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.\n", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_AllPrices_VolumePrices" } } }, "required": [ "price", "unit_origin_price", "volume_prices" ] }, "OF21_Response_200_Offers_AllPrices_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.", "items": { "type": "string" } }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price." } } }, "OF21_Response_200_Offers_AllPrices_VolumePrices": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price." }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity threshold of this price range" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } }, "required": [ "price", "quantity_threshold", "unit_discount_price", "unit_origin_price" ] }, "OF21_Response_200_Offers_ApplicablePricing": { "type": "object", "properties": { "channel_code": { "type": "string", "deprecated": true, "description": " Single Channel Pricing users: The channel code on which a specific price applies.\n This is the pricing_channel_code supplied as input in the API if prices are defined for this channel.\n If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices.\n channel_code is set to null for the default prices. Multi Channel Pricing users: returned null.\n Refer to context > channel_codes in order to retrieve the channel codes for which the price apply.\n" }, "context": { "$ref": "#/components/schemas/OF21_Response_200_Offers_ApplicablePricing_Context", "description": "The context is not returned for default prices.\n" }, "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer.\n
\nFor Dropship specifically: the purchasing price of the offer\n
\nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
\nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount price for a quantity of one, i.e. the discount price for a quantity of one.\n
\nFor Dropship specifically: the discount purchasing price for a quantity of one\n
\nSet to null if no discount is defined or if no discount price for a quantity of one is defined.\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts.\n
\nFor Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.\n", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_ApplicablePricing_VolumePrices" } } }, "required": [ "price", "unit_origin_price", "volume_prices" ] }, "OF21_Response_200_Offers_ApplicablePricing_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.", "items": { "type": "string" } }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price." } } }, "OF21_Response_200_Offers_ApplicablePricing_VolumePrices": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price." }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity threshold of this price range" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } }, "required": [ "price", "quantity_threshold", "unit_discount_price", "unit_origin_price" ] }, "OF21_Response_200_Offers_Discount": { "type": "object", "deprecated": true, "properties": { "discount_price": { "type": "number", "format": "with decimals", "description": "Discount price. Not to be read if discount with ranges is specified (i.e. discount with at least one range with quantity threshold greater than one).
For Dropship specifically: the purchasing discount price." }, "end_date": { "type": "string", "format": "date-time", "description": "Discount end date" }, "origin_price": { "type": "number", "format": "with decimals", "description": "Origin price
For Dropship specifically: the origin purchasing price" }, "ranges": { "type": "array", "description": "Discount ranges", "items": { "$ref": "#/components/schemas/OF21_Response_200_Offers_Discount_Ranges" } }, "start_date": { "type": "string", "format": "date-time", "description": "Discount start date" } } }, "OF21_Response_200_Offers_Discount_Ranges": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer if the quantity threshold is reached" }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Minimum quantity to order for the given price to be applied" } }, "required": [ "price", "quantity_threshold" ] }, "OF21_Response_200_Offers_EcoContributions": { "type": "object", "properties": { "eco_contribution_amount": { "type": "number", "format": "with decimals", "description": "Amount of the eco-contribution." }, "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Producer identifier of the eco-contribution.
Not present if the producer identifier belongs to the operator.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code" ] }, "OF21_Response_200_Offers_Fulfillment": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/OF21_Response_200_Offers_Fulfillment_Center", "description": "Fulfillment center code" } }, "required": [ "center" ] }, "OF21_Response_200_Offers_Fulfillment_Center": { "type": "object", "properties": { "code": { "type": "string", "description": "Center code" } }, "required": [ "code" ] }, "OF21_Response_200_Offers_LogisticClass": { "type": "object", "properties": { "code": { "type": "string", "description": "Logistic class code" }, "label": { "type": "string", "description": "Logistic class label " } }, "required": [ "code", "label" ] }, "OF21_Response_200_Offers_OfferAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_Boolean", "DATE": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_Date", "LINK": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_Link", "LIST": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_Numeric", "REGEX": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_Regex", "STRING": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_String", "TEXTAREA": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_OfferAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF21_Response_200_Offers_OfferAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF21_Response_200_Offers_ProductReferences": { "type": "object", "properties": { "reference": { "type": "string", "description": "Value of the reference" }, "reference_type": { "type": "string", "description": "Type of the reference" } }, "required": [ "reference", "reference_type" ] }, "OF21_Response_200_Offers_RetailPrices": { "type": "object", "properties": { "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Retail price of the offer, also referred to as selling price.\n
\nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
\nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount retail price for a quantity of one, i.e. the discount retail price for a quantity of one.\n
\nSet to null if no discount is defined or if no discount retail price for a quantity of one is defined or if the discount is not currently active (within the validity interval).\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original retail price for a quantity of one, i.e. the retail price for a quantity of one regardless of the discounts." } }, "required": [ "price", "unit_origin_price" ] }, "OF21_Response_200_Offers_Warehouses": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the warehouse" }, "quantity": { "type": "integer", "format": "int32", "description": "The available quantity of the offer for the warehouse" } }, "required": [ "code", "quantity" ] }, "OF22_Response_200": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Is the offer active" }, "all_prices": { "type": "array", "description": "All prices for the offer\n
\nFor Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices\n", "items": { "$ref": "#/components/schemas/OF22_Response_200_AllPrices" } }, "allow_quote_requests": { "type": "boolean", "description": "Whether the offer is eligible for quotation" }, "applicable_pricing": { "$ref": "#/components/schemas/OF22_Response_200_ApplicablePricing", "description": "Pricing defined for the offer, including the prices for the selected channel if available\n
\nFor Dropship specifically: the list of applicable purchasing prices of the offer, also referred to as costs or wholesale prices.\n" }, "available_end_date": { "type": "string", "format": "date-time", "description": "Available end date" }, "available_start_date": { "type": "string", "format": "date-time", "description": "Available start date" }, "category_code": { "type": "string", "description": "Product category code" }, "category_label": { "type": "string", "description": "Product category label " }, "channels": { "type": "array", "description": "List of channel codes on which the offer can be sold", "items": { "type": "string" }, "uniqueItems": true }, "currency_iso_code": { "type": "string", "description": "The currency of the shop (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "description": { "type": "string", "description": "Offer description" }, "discount": { "$ref": "#/components/schemas/OF22_Response_200_Discount", "deprecated": true, "description": "

Discount of the offer

Please use 'applicablePricing' instead

" }, "eco_contributions": { "type": "array", "description": "Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "items": { "$ref": "#/components/schemas/OF22_Response_200_EcoContributions" }, "maxItems": 20 }, "favorite_rank": { "type": "integer", "format": "int32", "description": "Favorite rank for the offer, when the favorite feature is enabled and the offer is a favorite" }, "fulfillment": { "$ref": "#/components/schemas/OF22_Response_200_Fulfillment", "description": "Fulfillment information" }, "inactivity_reasons": { "type": "array", "description": "Reasons for offers inactivity, mandatory if an offer is inactive", "items": { "type": "string", "description": "Enum: `\"PRODUCT_STATUS_NEW\"`, `\"PRODUCT_STATUS_INVALID\"`, `\"PRODUCT_STATUS_REJECTED\"`, `\"PRODUCT_STATUS_UNAUTHORIZED_TO_SELL\"`, `\"PRODUCT_STATUS_PENDING\"`, `\"PRODUCT_STATUS_SYNCHRO_ERROR\"`, `\"PRODUCT_DISABLED\"`, `\"SHOP_NOT_OPEN\"`, `\"ZERO_QUANTITY\"`, `\"NO_MIN_SHIPPING_RATE\"`, `\"NOT_IN_AVAILABILITY_PERIOD\"`, `\"NO_CHANNEL_ON_SHOP\"`, `\"SHOP_CURRENCY_DISABLED\"`, `\"AVAILABLE_QUANTITY_LESS_THAN_MIN_ORDER_QUANTITY\"`, `\"AVAILABLE_QUANTITY_LESS_THAN_PACKAGE_QUANTITY\"`, `\"NO_ACTIVE_PRICE\"`, `\"CATEGORY_UNAUTHORIZED_TO_SELL\"`, `\"BRAND_UNAUTHORIZED_TO_SELL\"`, `\"OFFER_STATE_UNAUTHORIZED_TO_SELL\"`\n" } }, "internal_description": { "type": "string", "description": "The offer's description as shown in the back office" }, "leadtime_to_ship": { "type": "integer", "format": "int32", "description": "Offer's lead time to ship value. If this value has been set to 0, value is returned as 1 (unless platform's default lead time to ship value is also 0). If no lead time to ship was specified for the offer, platform's default value is returned." }, "logistic_class": { "$ref": "#/components/schemas/OF22_Response_200_LogisticClass", "description": "The logistic class associated to the offer" }, "max_order_quantity": { "type": "integer", "format": "int32", "description": "Highest quantity of product items per order" }, "min_order_quantity": { "type": "integer", "format": "int32", "description": "Lowest quantity of product items per order" }, "min_quantity_alert": { "type": "integer", "format": "int32", "description": "Mininum quantity of the offer" }, "min_shipping_price": { "type": "number", "format": "with decimals", "description": "Unit price of the minimum shipping rate" }, "min_shipping_price_additional": { "type": "number", "format": "with decimals", "description": "Additional unit price associated to the minimum shipping rate" }, "min_shipping_type": { "type": "string", "description": "Code of the shipping type associated to the minimum shipping rate" }, "min_shipping_zone": { "type": "string", "description": "Code of the shipping zone associated to the minimum shipping rate" }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).\n
\nApplicable only for Dropship offers.\n" }, "offer_additional_fields": { "type": "array", "description": "Custom fields of the offer", "items": { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } }, "offer_id": { "type": "integer", "format": "int64", "description": "Identifier of the offer" }, "package_quantity": { "type": "integer", "format": "int32", "description": "Indivisible quantity of the same product" }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer\n
\nFor Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price\n" }, "price_additional_info": { "type": "string", "description": "Additional price information for the offer" }, "product_brand": { "type": "string", "description": "Brand of the product" }, "product_description": { "type": "string", "description": "Description of the product" }, "product_references": { "type": "array", "description": "Product references", "items": { "$ref": "#/components/schemas/OF22_Response_200_ProductReferences" } }, "product_sku": { "type": "string", "description": "Product SKU" }, "product_tax_code": { "type": "string", "description": "Offer product tax code" }, "product_title": { "type": "string", "description": "Product title" }, "quantity": { "type": "integer", "format": "int32", "description": "Available quantity of the offer" }, "retail_prices": { "type": "array", "description": "List retail prices for the offer, also referred to as selling prices.\n
\nApplicable only for Dropship offers.\n", "items": { "$ref": "#/components/schemas/OF22_Response_200_RetailPrices" } }, "shipping_deadline": { "type": "string", "format": "date-time", "description": "Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers" }, "shop_sku": { "type": "string", "description": "The offer's shop SKU" }, "state_code": { "type": "string", "description": "Offer condition" }, "total_price": { "type": "number", "format": "with decimals", "description": "Total price of the offer (price + minimum shipping rate)\n
\nFor Dropship specifically: the purchasing price of the offer + minimum shipping rate\n" }, "warehouses": { "type": "array", "description": "The breakdown of the available quantities of the offer in each warehouse.", "items": { "$ref": "#/components/schemas/OF22_Response_200_Warehouses" } } }, "required": [ "active", "all_prices", "category_code", "category_label", "channels", "currency_iso_code", "description", "fulfillment", "leadtime_to_ship", "logistic_class", "max_order_quantity", "min_order_quantity", "min_quantity_alert", "min_shipping_price", "min_shipping_price_additional", "min_shipping_type", "min_shipping_zone", "offer_id", "package_quantity", "product_references", "product_sku", "product_title", "quantity", "shipping_deadline", "shop_sku", "state_code" ] }, "OF22_Response_200_AllPrices": { "type": "object", "properties": { "channel_code": { "type": "string", "deprecated": true, "description": " Single Channel Pricing users: The channel code on which a specific price applies.\n This is the pricing_channel_code supplied as input in the API if prices are defined for this channel.\n If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices.\n channel_code is set to null for the default prices. Multi Channel Pricing users: returned null.\n Refer to context > channel_codes in order to retrieve the channel codes for which the price apply.\n" }, "context": { "$ref": "#/components/schemas/OF22_Response_200_AllPrices_Context", "description": "The context is not returned for default prices.\n" }, "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer.\n
\nFor Dropship specifically: the purchasing price of the offer\n
\nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
\nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount price for a quantity of one, i.e. the discount price for a quantity of one.\n
\nFor Dropship specifically: the discount purchasing price for a quantity of one\n
\nSet to null if no discount is defined or if no discount price for a quantity of one is defined.\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts.\n
\nFor Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.\n", "items": { "$ref": "#/components/schemas/OF22_Response_200_AllPrices_VolumePrices" } } }, "required": [ "price", "unit_origin_price", "volume_prices" ] }, "OF22_Response_200_AllPrices_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.", "items": { "type": "string" } }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price." } } }, "OF22_Response_200_AllPrices_VolumePrices": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price." }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity threshold of this price range" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } }, "required": [ "price", "quantity_threshold", "unit_discount_price", "unit_origin_price" ] }, "OF22_Response_200_ApplicablePricing": { "type": "object", "properties": { "channel_code": { "type": "string", "deprecated": true, "description": " Single Channel Pricing users: The channel code on which a specific price applies.\n This is the pricing_channel_code supplied as input in the API if prices are defined for this channel.\n If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices.\n channel_code is set to null for the default prices. Multi Channel Pricing users: returned null.\n Refer to context > channel_codes in order to retrieve the channel codes for which the price apply.\n" }, "context": { "$ref": "#/components/schemas/OF22_Response_200_ApplicablePricing_Context", "description": "The context is not returned for default prices.\n" }, "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer.\n
\nFor Dropship specifically: the purchasing price of the offer\n
\nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
\nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount price for a quantity of one, i.e. the discount price for a quantity of one.\n
\nFor Dropship specifically: the discount purchasing price for a quantity of one\n
\nSet to null if no discount is defined or if no discount price for a quantity of one is defined.\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts.\n
\nFor Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.\n", "items": { "$ref": "#/components/schemas/OF22_Response_200_ApplicablePricing_VolumePrices" } } }, "required": [ "price", "unit_origin_price", "volume_prices" ] }, "OF22_Response_200_ApplicablePricing_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.", "items": { "type": "string" } }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price." } } }, "OF22_Response_200_ApplicablePricing_VolumePrices": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price." }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity threshold of this price range" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } }, "required": [ "price", "quantity_threshold", "unit_discount_price", "unit_origin_price" ] }, "OF22_Response_200_Discount": { "type": "object", "deprecated": true, "properties": { "discount_price": { "type": "number", "format": "with decimals", "description": "Discount price. Not to be read if discount with ranges is specified (i.e. discount with at least one range with quantity threshold greater than one).
For Dropship specifically: the purchasing discount price." }, "end_date": { "type": "string", "format": "date-time", "description": "Discount end date" }, "origin_price": { "type": "number", "format": "with decimals", "description": "Origin price
For Dropship specifically: the origin purchasing price" }, "ranges": { "type": "array", "description": "Discount ranges", "items": { "$ref": "#/components/schemas/OF22_Response_200_Discount_Ranges" } }, "start_date": { "type": "string", "format": "date-time", "description": "Discount start date" } } }, "OF22_Response_200_Discount_Ranges": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer if the quantity threshold is reached" }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Minimum quantity to order for the given price to be applied" } }, "required": [ "price", "quantity_threshold" ] }, "OF22_Response_200_EcoContributions": { "type": "object", "properties": { "eco_contribution_amount": { "type": "number", "format": "with decimals", "description": "Amount of the eco-contribution." }, "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Producer identifier of the eco-contribution.
Not present if the producer identifier belongs to the operator.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code" ] }, "OF22_Response_200_Fulfillment": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/OF22_Response_200_Fulfillment_Center", "description": "Fulfillment center code" } }, "required": [ "center" ] }, "OF22_Response_200_Fulfillment_Center": { "type": "object", "properties": { "code": { "type": "string", "description": "Center code" } }, "required": [ "code" ] }, "OF22_Response_200_LogisticClass": { "type": "object", "properties": { "code": { "type": "string", "description": "Logistic class code" }, "label": { "type": "string", "description": "Logistic class label " } }, "required": [ "code", "label" ] }, "OF22_Response_200_OfferAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_Boolean", "DATE": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_Date", "LINK": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_Link", "LIST": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_Numeric", "REGEX": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_Regex", "STRING": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_String", "TEXTAREA": "#/components/schemas/OF22_Response_200_OfferAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OF22_Response_200_OfferAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_OfferAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF22_Response_200_ProductReferences": { "type": "object", "properties": { "reference": { "type": "string", "description": "Value of the reference" }, "reference_type": { "type": "string", "description": "Type of the reference" } }, "required": [ "reference", "reference_type" ] }, "OF22_Response_200_RetailPrices": { "type": "object", "properties": { "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Retail price of the offer, also referred to as selling price.\n
\nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
\nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount retail price for a quantity of one, i.e. the discount retail price for a quantity of one.\n
\nSet to null if no discount is defined or if no discount retail price for a quantity of one is defined or if the discount is not currently active (within the validity interval).\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original retail price for a quantity of one, i.e. the retail price for a quantity of one regardless of the discounts." } }, "required": [ "price", "unit_origin_price" ] }, "OF22_Response_200_Warehouses": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the warehouse" }, "quantity": { "type": "integer", "format": "int32", "description": "The available quantity of the offer for the warehouse" } }, "required": [ "code", "quantity" ] }, "OF24_Request": { "type": "object", "properties": { "offers": { "type": "array", "description": "Offers list", "items": { "$ref": "#/components/schemas/OF24_Request_Offers" } } }, "required": [ "offers" ] }, "OF24_Request_Offers": { "type": "object", "description": "Offers list", "properties": { "all_prices": { "type": "array", "description": "The volume and channel prices.", "items": { "$ref": "#/components/schemas/OF24_Request_Offers_AllPrices" } }, "allow_quote_requests": { "type": "boolean", "description": "Whether the offer is eligible for quotation. Offer update: if not provided, will be set to false." }, "available_ended": { "type": "string", "description": "End date of the period of availability. Offer update: if not provided, existing data will be deleted." }, "available_started": { "type": "string", "description": "Started date of the period of availability. Offer update: if not provided, existing data will be deleted." }, "description": { "type": "string", "description": "Description of the offer. Offer update: if not provided, existing data will be deleted." }, "discount": { "$ref": "#/components/schemas/OF24_Request_Offers_Discount", "description": "Discount of an offer. Offer update: if not provided, existing data will be deleted." }, "eco_contributions": { "type": "array", "description": "Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled. Offer update: if not provided, existing data will be deleted.", "items": { "$ref": "#/components/schemas/OF24_Request_Offers_EcoContributions" } }, "internal_description": { "type": "string", "description": "Internal description of the offer. Offer update: if not provided, existing data will be deleted." }, "leadtime_to_ship": { "type": "integer", "format": "int32", "description": "Leadtime to ship of the offer, in days. Offer update: if not provided, existing data will be deleted." }, "logistic_class": { "type": "string", "description": "Offer logistic class. Offer update: if not provided, existing data will be deleted." }, "max_order_quantity": { "type": "integer", "format": "int32", "description": "The maximum quantity of product items per order. Offer update: if not provided, existing data will be deleted." }, "min_order_quantity": { "type": "integer", "format": "int32", "description": "The minimum quantity of product items per order. Offer update: if not provided, existing data will be deleted." }, "min_quantity_alert": { "type": "integer", "format": "int32", "description": "The minimum stock level that triggers an email alert. No alerts are sent if this field is not specified. Offer update: if not provided, existing data will be deleted." }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP). Only applicable for Dropship offers." }, "offer_additional_fields": { "type": "array", "description": "Custom fields of the offer", "items": { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } }, "package_quantity": { "type": "integer", "format": "int32", "description": "The indivisible selling quantity of the same product. Offer update: if not provided, existing data will be deleted." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. For Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price." }, "price_additional_info": { "type": "string", "description": "Price additional information of the offer. Offer update: if not provided, existing data will be deleted." }, "pricing_unit": { "type": "string", "description": "The unit corresponding to the submitted price when the price per measurement unit feature is used." }, "product_id": { "type": "string", "description": "Reference of the product associated with the offer. Required at offer creation. Optional at offer update." }, "product_id_type": { "type": "string", "description": "Reference type of the product associated with the offer. Required at offer creation. Optional at offer update." }, "product_tax_code": { "type": "string", "description": "Product tax code associated to the offer. When Operator mandatorily collects product tax codes on offers, required at offer creation and update. When Operator optionally collects product tax codes on offers, if no value is provided at offer update, existing data will be deleted." }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity available of the offer. Offer update: if not provided, will be set to 0." }, "retail_prices": { "type": "array", "description": "The retail prices of the offer, also referred to as selling prices. Applicable only for Dropship offers.", "items": { "$ref": "#/components/schemas/OF24_Request_Offers_RetailPrices" } }, "shop_sku": { "type": "string", "description": "Sku of the offer" }, "state_code": { "type": "string", "description": "State of the offer" }, "update_delete": { "type": "string", "description": "Update delete flag. Could be empty (means \"update\"), \"update\" or \"delete\"." } }, "required": [ "price", "product_id", "product_id_type", "shop_sku", "state_code", "update_delete" ] }, "OF24_Request_Offers_AllPrices": { "type": "object", "description": "The volume and channel prices.", "properties": { "channel_code": { "type": "string", "description": "The channel code the prices will be linked to. To set the default prices, set it to null." }, "discount_end_date": { "type": "string", "description": "The end date of the discount. May be required when a discount price is set, check platform configuration. If no discount is desired, set it to null." }, "discount_start_date": { "type": "string", "description": "The start date of the discount. May be required when a discount price is set, check platform configuration. If no discount is desired, set it to null." }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "The default unit discount price, i.e. the unit price when the discount applied." }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "The default unit original price, i.e. the unit price without taking discounts nor volume prices into account." }, "volume_prices": { "type": "array", "description": "The volume prices applicable for the offer.", "items": { "$ref": "#/components/schemas/OF24_Request_Offers_AllPrices_VolumePrices" } } } }, "OF24_Request_Offers_AllPrices_VolumePrices": { "type": "object", "description": "The volume prices applicable for the offer.", "properties": { "quantity_threshold": { "type": "integer", "format": "int32", "description": "The quantity threshold from which the volume price is applicable" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "The unit discount price, i.e. the unit price when the discount applies" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "The unit original price, i.e. the unit price excluding discounts" } }, "required": [ "quantity_threshold", "unit_origin_price" ] }, "OF24_Request_Offers_Discount": { "type": "object", "description": "Discount of an offer. Offer update: if not provided, existing data will be deleted.", "properties": { "end_date": { "type": "string", "description": "Discount end date. May be required when a discount price is set, check platform configuration. Offer update: if not provided, existing data will be deleted." }, "price": { "type": "number", "format": "with decimals", "description": "Discount price. Not to be used when ranges are specified. Offer update: if not provided, existing data will be deleted. For Dropship specifically: the discount purchasing price of the offer, also referred to as discount cost or discount wholesale price." }, "ranges": { "type": "array", "description": "Discount ranges. Offer update: if not provided, existing data will be deleted.", "items": { "$ref": "#/components/schemas/OF24_Request_Offers_Discount_Ranges" } }, "start_date": { "type": "string", "description": "Discount start date. May be required when a discount price is set, check platform configuration. Offer update: if not provided, existing data will be deleted." } } }, "OF24_Request_Offers_Discount_Ranges": { "type": "object", "description": "Discount ranges. Offer update: if not provided, existing data will be deleted.", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer if the quantity threshold is reached" }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Minimum quantity to order for the given price to be applied" } }, "required": [ "price", "quantity_threshold" ] }, "OF24_Request_Offers_EcoContributions": { "type": "object", "properties": { "eco_contribution_amount": { "type": "number", "format": "with decimals", "description": "Amount of the eco-contribution. Offer update: if not provided, existing data will be deleted." }, "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n" }, "producer_id": { "type": "string", "description": "Producer identifier of the eco-contribution. Offer update: if not provided, existing data will be deleted." } }, "required": [ "epr_category_code" ] }, "OF24_Request_Offers_OfferAdditionalFields": { "type": "object", "description": "Custom fields of the offer", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_Boolean", "DATE": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_Date", "LINK": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_Link", "LIST": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_Numeric", "REGEX": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_Regex", "STRING": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_String", "TEXTAREA": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OF24_Request_Offers_OfferAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_OfferAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OF24_Request_Offers_RetailPrices": { "type": "object", "description": "The retail prices of the offer, also referred to as selling prices. Applicable only for Dropship offers.", "properties": { "discount_end_date": { "type": "string", "description": "The end date of the discount. May be required when a discount price is set, check platform configuration. If no discount is desired, set it to null." }, "discount_start_date": { "type": "string", "description": "The start date of the discount. May be required when a discount price is set, check platform configuration. If no discount is desired, set it to null." }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "The default unit discount retail price, i.e. the retail unit price when the discount applied." }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "The default unit original retail price, i.e. the retail unit price without discount." } } }, "OF24_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." } }, "required": [ "import_id" ] }, "OF26_Response_200": { "type": "object", "properties": { "offer_id": { "type": "integer", "format": "int64", "description": "Offer identifier" }, "quantity": { "type": "integer", "format": "int32", "description": "Get the quantity of stock available for this offer.
Quantity return rules:
" } }, "required": [ "offer_id", "quantity" ] }, "OF51_Response_200_TextCsv_Ext_FileStructure": { "type": "object", "description": "Offer CSV output", "properties": { "active": { "type": "boolean", "description": "Indicates if the offer is active or inactive (not for sale or discontinued)" }, "allow-quote-requests": { "type": "boolean", "description": "Allow customers to request quotes on this offer" }, "available-end-date": { "type": "string", "description": "The date when the offer will be deactivated" }, "available-start-date": { "type": "string", "description": "The date when the offer will be activated" }, "channels": { "type": "string", "description": "List of channel codes on which the offer can be sold." }, "currency-iso-code": { "type": "string", "description": "ISO code of the currency\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date-created": { "type": "string", "description": "Date and time of the offer creation" }, "deleted": { "type": "boolean", "description": "Indicates whether the offer exists or is deleted" }, "delivery-time-earliest-days[zone=,method=]": { "type": "string", "description": "Minimum delivery time.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "delivery-time-latest-days[zone=,method=]": { "type": "string", "description": "Maximum delivery time.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "description": { "type": "string", "description": "Offer description" }, "discount-end-date": { "type": "string", "description": "The end date of the discount period.
\nFor Dropship specifically: the end date of the discount period on the purchasing price\n" }, "discount-end-date[channel=]": { "type": "string", "description": "The end date of the discount period for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty. In this case, the discount price applies from the start date and is then always available for the indicated channel.\n" }, "discount-price": { "type": "number", "format": "with decimals", "description": "The discount price of the offer
\nFor Dropship specifically: the discount purchasing price of the offer, also referred to as cost or wholesale price\n" }, "discount-price[channel=]": { "type": "number", "format": "with decimals", "description": "The discount price of an offer for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty when no discount price is defined for a given channel. In this case, the default discount price of the offer applies to the indicated channel.\n" }, "discount-ranges": { "type": "string", "description": "The ranges of the discount prices when the Volume Pricing feature is activated.\n" }, "discount-ranges[channel=]": { "type": "string", "description": "The ranges of the discount prices for the indicated channel, when the Channel Pricing and Volume Discount features are activated.\n" }, "discount-retail-price": { "type": "number", "format": "with decimals", "description": "The discount retail price of the offer.
\nApplicable only for Dropship offers.\n" }, "discount-retail-price-end-date": { "type": "string", "description": "The end date of the discount period for the retail price.
\nApplicable only for Dropship offers.\n" }, "discount-retail-price-start-date": { "type": "string", "description": "The start date of the discount period for the retail price.
\nApplicable only for Dropship offers.\n" }, "discount-start-date": { "type": "string", "description": "The start date of the discount period.
\nFor Dropship specifically: the start date of the discount period on the purchasing price\n" }, "discount-start-date[channel=]": { "type": "string", "description": "The start date of the discount period for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty. In this case, the discount price applies from the start date and is then always available for the indicated channel.\n" }, "eco-contribution-amount[EPR category code]": { "type": "number", "format": "with decimals", "description": "Amount of the eco-contribution for the EPR category. Returned if Data collection related to circular economy regulations is enabled.\n" }, "favorite-rank": { "type": "integer", "format": "int32", "description": "If present, indicates that the offer is a favorite offer ranked" }, "fulfillment-center-code": { "type": "string", "description": "Code of the fullfilment center" }, "last-updated": { "type": "string", "description": "Date and time of the last update of the offer" }, "leadtime-to-ship": { "type": "integer", "format": "int32", "description": "The lead time to ship corresponding to the offer" }, "logistic-class": { "type": "string", "description": "The logistic class associated to the offer" }, "max-order-quantity": { "type": "integer", "format": "int32", "description": "The maximum order quantity customers must select to be able to place an order for that offer" }, "measurement-units": { "type": "string", "description": "The product measurement and the product unit
\nThis option is only available if the operator creates a product with a measurement unit.\n" }, "min-order-quantity": { "type": "integer", "format": "int32", "description": "The minimum order quantity customers must select to be able to place an order for that offer" }, "min-shipping-price": { "type": "number", "format": "with decimals", "description": "Minimum shipping charges for the offer" }, "min-shipping-price-additional": { "type": "number", "format": "with decimals", "description": "Additional shipping charges for the offer" }, "min-shipping-type": { "type": "string", "description": "Shipping method with the minimum shipping charges (code referenced by the operator)" }, "min-shipping-zone": { "type": "string", "description": "Shipping zone with the minimum shipping charges (code referenced by the operator)" }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).
\nApplicable only for Dropship offers.\n" }, "offer-id": { "type": "integer", "format": "int64", "description": "Unique offer identifier assigned by Mirakl" }, "ongoing-discount-campaigns": { "type": "string", "description": "Ongoing discount campaigns the offer is currently participating in.
\nNot returned if the offer is not currently participating in any discount campaign or if Discount Campaign feature is disabled.\n" }, "origin-price": { "type": "number", "format": "with decimals", "description": "The original price of the offer
\nFor Dropship specifically: the original purchasing price of the offer, also referred to as cost or wholesale price\n" }, "origin-price[channel=]": { "type": "number", "format": "with decimals", "description": "The original price granted for an offer for the indicated channel\n" }, "origin-retail-price": { "type": "number", "format": "with decimals", "description": "The original retail price of the offer, also referred to as original selling price.
\nApplicable only for Dropship offers.\n" }, "package-quantity": { "type": "integer", "format": "int32", "description": "For one order, customers can only add packages of product items.
\nThe number of items per package is the increment number of that product in an order.\n" }, "premium": { "type": "boolean", "description": "Indicates if the store is premium or not" }, "price": { "type": "number", "format": "with decimals", "description": "Offer current price (original price or discount price if in discount period)\nFor Dropship specifically: the purchasing price of the offer (original price or discount price if in discount period), also referred to as cost or wholesale price\n" }, "price-additional-info": { "type": "string", "description": "Information about the offer price" }, "price-ranges": { "type": "string", "description": "The price ranges when the Volume Pricing feature is activated.\n" }, "price-ranges[channel=]": { "type": "string", "description": "The price ranges for the indicated channel when the Channel Pricing and the Volume Pricing features are activated.
\nCan be empty when no specific price range is defined for a given channel.\n" }, "price[channel=]": { "type": "number", "format": "with decimals", "description": "The unit price of an offer for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty when no specific price is defined for a given channel. In this case, the base price of the offer applies to the indicated channel.\n" }, "producer-id[EPR category code]": { "type": "string", "description": "Producer identifier of the eco-contribution for the EPR category. Returned if Data collection related to circular economy regulations is enabled.\n
Not present if the producer identifier belongs to the operator.", "maxLength": 255 }, "product-sku": { "type": "string", "description": "Product identifier within the operator's system" }, "product-tax-code": { "type": "string", "description": "Tax code for the product" }, "professional": { "type": "boolean", "description": "Indicates if the store is professional or not" }, "quantity": { "type": "integer", "format": "int32", "description": "Offer quantity available" }, "retail-price": { "type": "number", "format": "with decimals", "description": "Offer current retail price (original retail price or discount retail price if in discount period). Also referred to as selling price.
\nApplicable only for Dropship offers.\n" }, "shipping-price-type[zone=,method=]": { "type": "string", "description": "Shipping charges type for the offer, for each combination of shipping zone and method.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n\n\nEnum: `\"FREE_SHIPPING\"`, `\"FIXED_PRICE\"`, `\"ORDER_PRICE_RANGE\"`\n" }, "shipping-price[zone=,method=]": { "type": "number", "format": "with decimals", "description": "Shipping charges for the offer, for each combination of shipping zone and method.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "shop-id": { "type": "integer", "format": "int64", "description": "Unique identifier for the store providing this offer (assigned by Mirakl)" }, "shop-name": { "type": "string", "description": "Name of the store providing this offer" }, "shop-sku": { "type": "string", "description": "Shop's sku of the offer" }, "state-code": { "type": "string", "description": "Offer condition code" }, "total-price": { "type": "number", "format": "with decimals", "description": "Offer price + minimum shipping charge
\nFor Dropship specifically: the purchasing price of the offer + minimum shipping charge\n" } } }, "OF52_Request": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "List of the channel codes to filter with. 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.", "items": { "type": "string" } }, "export_type": { "type": "string", "description": "Format of the generated files: CSV or JSON (value is either text/csv or application/json). Default to text/csv.\n\nEnum: `\"text/csv\"`, `\"application/json\"`\n" }, "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.
When calling the API in differential mode (i.e. when the last_request_date is provided), both active and inactive offers are returned. This field cannot be used in differential mode otherwise the call fails." }, "items_per_chunk": { "type": "integer", "format": "int64", "description": "The maximum number of items per chunk", "maximum": 1000000, "minimum": 10000 }, "last_request_date": { "type": "string", "format": "date-time", "description": "Date and time of your last request.
If provided, retrieves all offers updated since this date and time, including deleted and inactive offers.
If not provided, retrieves all active offers only, unless otherwise specified in the include_inactive_offers field." }, "megabytes_per_chunk": { "type": "integer", "format": "int64", "description": "The maximum size in megabytes of a chunk", "maximum": 1000, "minimum": 10 }, "ongoing_discount_campaign_identifiers": { "type": "array", "description": "List of discount campaign identifiers to filter with. If specified, only offers currently participating in the specified ongoing discount campaign(s) will be returned.", "items": { "type": "string" } }, "rename_fields": { "type": "object", "additionalProperties": { "type": "string" }, "description": "This is only supported for CSV export. Can be used to modify the name of the CSV headers. The expected format is a JSON object with the original fields as keys and the substitute as value. 
{\"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" } } }, "OF54_Response_200_Ext_FileStructure": { "type": "object", "description": "Offer JSON output", "properties": { "active": { "type": "boolean", "description": "Indicates if the offer is active or inactive (not for sale or discontinued)" }, "allow_quote_requests": { "type": "boolean", "description": "Allow customers to request quotes on this offer" }, "available_end_date": { "type": "string", "description": "The date when the offer will be deactivated" }, "available_start_date": { "type": "string", "description": "The date when the offer will be activated" }, "channels": { "type": "array", "description": "List of channel codes on which the offer can be sold.", "items": { "type": "string" } }, "currency_iso_code": { "type": "string", "description": "ISO code of the currency" }, "date_created": { "type": "string", "description": "Date and time of the offer creation" }, "deleted": { "type": "boolean", "description": "Indicates whether the offer exists or is deleted" }, "description": { "type": "string", "description": "Offer description" }, "eco_contributions": { "type": "array", "description": "Eco-contributions of the offer - only available if the operator setting Data collection related to circular economy regulations has been enabled.\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_EcoContributions" } }, "favorite_rank": { "type": "integer", "format": "int32", "description": "If present, indicates that the offer is a favorite offer ranked" }, "fulfillment": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Fulfillment", "description": "The fulfillment information tied to the offer" }, "is_professional": { "type": "boolean", "description": "Indicates if the store is professional or not" }, "last_updated": { "type": "string", "description": "Date and time of the last update of the offer" }, "leadtime_to_ship": { "type": "integer", "format": "int32", "description": "The lead time to ship corresponding to the offer" }, "logistic_class": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_LogisticClass", "description": "The logistic class associated to the offer" }, "max_order_quantity": { "type": "integer", "format": "int32", "description": "The maximum order quantity customers must select to be able to place an order for that offer" }, "measurement": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Measurement", "description": "Measurement of the product" }, "min_order_quantity": { "type": "integer", "format": "int32", "description": "The minimum order quantity customers must select to be able to place an order for that offer" }, "min_shipping_price": { "type": "number", "format": "with decimals", "description": "Minimum shipping charges for the offer" }, "min_shipping_price_additional": { "type": "number", "format": "with decimals", "description": "Additional shipping charges for the offer" }, "min_shipping_type": { "type": "string", "description": "Shipping method with the minimum shipping charges (code referenced by the operator)" }, "min_shipping_zone": { "type": "string", "description": "Shipping zone with the minimum shipping charges (code referenced by the operator)" }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).
\nApplicable only for Dropship offers.\n" }, "offer_additional_fields": { "type": "array", "description": "Custom fields of the offer", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_OfferAdditionalFields" } }, "offer_id": { "type": "integer", "format": "int64", "description": "Unique offer identifier assigned by Mirakl" }, "ongoing_discount_campaigns": { "type": "array", "description": "Ongoing discount campaigns the offer is currently participating in.
\nNot returned if the offer is not currently participating in any discount campaign or if Discount Campaign feature is disabled.\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_OngoingDiscountCampaigns" } }, "package_quantity": { "type": "integer", "format": "int32", "description": "For one order, customers can only add packages of product items.
\nThe number of items per package is the increment number of that product in an order.\n" }, "premium": { "type": "boolean", "description": "Indicates if the store is premium or not" }, "price_additional_info": { "type": "string", "description": "Information about the offer price" }, "prices": { "type": "array", "description": "List of prices for the offer.
\nFor Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Prices" }, "uniqueItems": true }, "product_sku": { "type": "string", "description": "Product identifier within the operator's system" }, "product_tax_code": { "type": "string", "description": "Tax code for the product" }, "quantity": { "type": "integer", "format": "int32", "description": "Offer quantity available" }, "retail_prices": { "type": "array", "description": "List retail prices for the offer, also referred to as selling prices.
\nApplicable only for Dropship offers.\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_RetailPrices" }, "uniqueItems": true }, "shipping_types": { "type": "array", "description": "List of shipping types for the offer.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_ShippingTypes" } }, "shop_id": { "type": "integer", "format": "int64", "description": "Unique identifier for the store providing this offer (assigned by Mirakl)" }, "shop_name": { "type": "string", "description": "Name of the store providing this offer" }, "shop_sku": { "type": "string", "description": "Shop's sku of the offer" }, "state_code": { "type": "string", "description": "Offer condition code" }, "warehouses": { "type": "array", "description": "The breakdown of the available quantities of the offer in each warehouse\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Warehouses" } } } }, "OF54_Response_200_Ext_FileStructure_EcoContributions": { "type": "object", "properties": { "eco_contribution_amount": { "type": "number", "format": "with decimals", "description": "List of eco-contribution amounts, if applicable
\nOnly taken into account if the operator activates the circular economy information collection.\n" }, "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\n\nEnum: `\"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\"`\n" }, "producer_id": { "type": "string", "description": "List of producer identifiers corresponding to eco contribution amounts, if applicable
\nOnly taken into account if the operator activates the circular economy information collection.
\nNot present if the producer identifier belongs to the operator.\n" } }, "required": [ "epr_category_code" ] }, "OF54_Response_200_Ext_FileStructure_Fulfillment": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Fulfillment_Center", "description": "The fulfillment center" } } }, "OF54_Response_200_Ext_FileStructure_Fulfillment_Center": { "type": "object", "properties": { "code": { "type": "string", "description": "Code of the fullfilment center" } } }, "OF54_Response_200_Ext_FileStructure_LogisticClass": { "type": "object", "properties": { "code": { "type": "string", "description": "Code for the logistic class linked to the offer (directly or via the Marketplace category)" } } }, "OF54_Response_200_Ext_FileStructure_Measurement": { "type": "object", "properties": { "total_measurement_of_product": { "type": "number", "format": "with decimals", "description": "The product measurement
\nThis option is only available if the operator creates a product with a measurement unit.\n" }, "unit": { "type": "string", "description": "The product unit
\nThis option is only available if the operator creates a product with a measurement unit.\n" } } }, "OF54_Response_200_Ext_FileStructure_OfferAdditionalFields": { "type": "object", "properties": { "code": { "type": "string", "description": "The custom field's code" }, "type": { "type": "string", "description": "One of BOOLEAN, DATE, LINK, LIST, MULTIPLE_VALUES_LIST, NUMERIC, REGEX, STRING, TEXTAREA" }, "value": { "type": "string", "description": "The custom field's value" } } }, "OF54_Response_200_Ext_FileStructure_OngoingDiscountCampaigns": { "type": "object", "description": "Ongoing discount campaign associated with the offer", "properties": { "identifier": { "type": "string", "description": "Unique identifier of the discount campaign" } } }, "OF54_Response_200_Ext_FileStructure_Prices": { "type": "object", "properties": { "context": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Prices_Context", "description": "Price application criteria
\nIs not returned for the default price\n" }, "discount_end_date": { "type": "string", "description": "End date of the discounted price.
\nFor Dropship specifically: the end date of the discounted purchasing price\n" }, "discount_price": { "type": "number", "format": "with decimals", "description": "Discounted price
\nIs not returned if a volume price with discount exists
\nFor Dropship specifically: the discounted purchasing price, also referred to as cost or wholesale price\n" }, "discount_start_date": { "type": "string", "description": "Start date of the discounted price.
\nFor Dropship specifically: the start date of the discounted purchasing price\n" }, "origin_price": { "type": "number", "format": "with decimals", "description": "Price without discount
\nFor Dropship specifically: the purchasing price, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold
\nReturns at least the price for a quantity threshold of one\n", "items": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_Prices_VolumePrices" } } } }, "OF54_Response_200_Ext_FileStructure_Prices_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.
Returned if Channel Pricing is enabled.", "items": { "type": "string" }, "uniqueItems": true }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.
Returned if Customer Pricing is enabled.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.
Returned if Customer Pricing is enabled.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price.
Returned if Scheduled Pricing is enabled." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price.
Returned if Scheduled Pricing is enabled." } } }, "OF54_Response_200_Ext_FileStructure_Prices_VolumePrices": { "type": "object", "properties": { "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity to trigger a discount in a volume pricing strategy" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } } }, "OF54_Response_200_Ext_FileStructure_RetailPrices": { "type": "object", "properties": { "discount_end_date": { "type": "string", "description": "End date of the discounted retail price" }, "discount_price": { "type": "number", "format": "with decimals", "description": "Discounted retail price" }, "discount_start_date": { "type": "string", "description": "Start date of the discounted retail price" }, "origin_price": { "type": "number", "format": "with decimals", "description": "Retail price without discount" } } }, "OF54_Response_200_Ext_FileStructure_ShippingTypes": { "type": "object", "properties": { "code": { "type": "string", "description": "Shipping method code" }, "delivery_time": { "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure_ShippingTypes_DeliveryTime", "description": "Expected order delivery time" }, "shipping_price_additional_unit": { "type": "number", "format": "with decimals", "description": "Additional shipping price of the offer" }, "shipping_price_type": { "type": "string", "description": "Shipping price type of the offer" }, "shipping_price_unit": { "type": "number", "format": "with decimals", "description": "Shipping price of the offer" }, "shipping_zone_code": { "type": "string", "description": "Shipping zone code" } } }, "OF54_Response_200_Ext_FileStructure_ShippingTypes_DeliveryTime": { "type": "object", "properties": { "earliest_days": { "type": "integer", "format": "int32", "description": "Earliest order delivery time" }, "latest_days": { "type": "integer", "format": "int32", "description": "Latest order delivery time" } } }, "OF54_Response_200_Ext_FileStructure_Warehouses": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the warehouse" }, "quantity": { "type": "integer", "format": "int32", "description": "The available quantity of the offer for the warehouse" } } }, "OF54_Response_200_TextCsv_Ext_FileStructure": { "type": "object", "description": "Offer CSV output", "properties": { "active": { "type": "boolean", "description": "Indicates if the offer is active or inactive (not for sale or discontinued)" }, "allow-quote-requests": { "type": "boolean", "description": "Allow customers to request quotes on this offer" }, "available-end-date": { "type": "string", "description": "The date when the offer will be deactivated" }, "available-start-date": { "type": "string", "description": "The date when the offer will be activated" }, "channels": { "type": "string", "description": "List of channel codes on which the offer can be sold." }, "currency-iso-code": { "type": "string", "description": "ISO code of the currency\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "date-created": { "type": "string", "description": "Date and time of the offer creation" }, "deleted": { "type": "boolean", "description": "Indicates whether the offer exists or is deleted" }, "delivery-time-earliest-days[zone=,method=]": { "type": "string", "description": "Minimum delivery time.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "delivery-time-latest-days[zone=,method=]": { "type": "string", "description": "Maximum delivery time.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "description": { "type": "string", "description": "Offer description" }, "discount-end-date": { "type": "string", "description": "The end date of the discount period.
\nFor Dropship specifically: the end date of the discount period on the purchasing price\n" }, "discount-end-date[channel=]": { "type": "string", "description": "The end date of the discount period for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty. In this case, the discount price applies from the start date and is then always available for the indicated channel.\n" }, "discount-price": { "type": "number", "format": "with decimals", "description": "The discount price of the offer
\nFor Dropship specifically: the discount purchasing price of the offer, also referred to as cost or wholesale price\n" }, "discount-price[channel=]": { "type": "number", "format": "with decimals", "description": "The discount price of an offer for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty when no discount price is defined for a given channel. In this case, the default discount price of the offer applies to the indicated channel.\n" }, "discount-ranges": { "type": "string", "description": "The ranges of the discount prices when the Volume Pricing feature is activated.\n" }, "discount-ranges[channel=]": { "type": "string", "description": "The ranges of the discount prices for the indicated channel, when the Channel Pricing and Volume Discount features are activated.\n" }, "discount-retail-price": { "type": "number", "format": "with decimals", "description": "The discount retail price of the offer.
\nApplicable only for Dropship offers.\n" }, "discount-retail-price-end-date": { "type": "string", "description": "The end date of the discount period for the retail price.
\nApplicable only for Dropship offers.\n" }, "discount-retail-price-start-date": { "type": "string", "description": "The start date of the discount period for the retail price.
\nApplicable only for Dropship offers.\n" }, "discount-start-date": { "type": "string", "description": "The start date of the discount period.
\nFor Dropship specifically: the start date of the discount period on the purchasing price\n" }, "discount-start-date[channel=]": { "type": "string", "description": "The start date of the discount period for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty. In this case, the discount price applies from the start date and is then always available for the indicated channel.\n" }, "eco-contribution-amount[EPR category code]": { "type": "number", "format": "with decimals", "description": "Amount of the eco-contribution for the EPR category. Returned if Data collection related to circular economy regulations is enabled.\n" }, "favorite-rank": { "type": "integer", "format": "int32", "description": "If present, indicates that the offer is a favorite offer ranked" }, "fulfillment-center-code": { "type": "string", "description": "Code of the fullfilment center" }, "last-updated": { "type": "string", "description": "Date and time of the last update of the offer" }, "leadtime-to-ship": { "type": "integer", "format": "int32", "description": "The lead time to ship corresponding to the offer" }, "logistic-class": { "type": "string", "description": "The logistic class associated to the offer" }, "max-order-quantity": { "type": "integer", "format": "int32", "description": "The maximum order quantity customers must select to be able to place an order for that offer" }, "measurement-units": { "type": "string", "description": "The product measurement and the product unit
\nThis option is only available if the operator creates a product with a measurement unit.\n" }, "min-order-quantity": { "type": "integer", "format": "int32", "description": "The minimum order quantity customers must select to be able to place an order for that offer" }, "min-shipping-price": { "type": "number", "format": "with decimals", "description": "Minimum shipping charges for the offer" }, "min-shipping-price-additional": { "type": "number", "format": "with decimals", "description": "Additional shipping charges for the offer" }, "min-shipping-type": { "type": "string", "description": "Shipping method with the minimum shipping charges (code referenced by the operator)" }, "min-shipping-zone": { "type": "string", "description": "Shipping zone with the minimum shipping charges (code referenced by the operator)" }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).
\nApplicable only for Dropship offers.\n" }, "offer-id": { "type": "integer", "format": "int64", "description": "Unique offer identifier assigned by Mirakl" }, "ongoing-discount-campaigns": { "type": "string", "description": "Ongoing discount campaigns the offer is currently participating in.
\nNot returned if the offer is not currently participating in any discount campaign or if Discount Campaign feature is disabled.\n" }, "origin-price": { "type": "number", "format": "with decimals", "description": "The original price of the offer
\nFor Dropship specifically: the original purchasing price of the offer, also referred to as cost or wholesale price\n" }, "origin-price[channel=]": { "type": "number", "format": "with decimals", "description": "The original price granted for an offer for the indicated channel\n" }, "origin-retail-price": { "type": "number", "format": "with decimals", "description": "The original retail price of the offer, also referred to as original selling price.
\nApplicable only for Dropship offers.\n" }, "package-quantity": { "type": "integer", "format": "int32", "description": "For one order, customers can only add packages of product items.
\nThe number of items per package is the increment number of that product in an order.\n" }, "premium": { "type": "boolean", "description": "Indicates if the store is premium or not" }, "price": { "type": "number", "format": "with decimals", "description": "Offer current price (original price or discount price if in discount period)\nFor Dropship specifically: the purchasing price of the offer (original price or discount price if in discount period), also referred to as cost or wholesale price\n" }, "price-additional-info": { "type": "string", "description": "Information about the offer price" }, "price-ranges": { "type": "string", "description": "The price ranges when the Volume Pricing feature is activated.\n" }, "price-ranges[channel=]": { "type": "string", "description": "The price ranges for the indicated channel when the Channel Pricing and the Volume Pricing features are activated.
\nCan be empty when no specific price range is defined for a given channel.\n" }, "price[channel=]": { "type": "number", "format": "with decimals", "description": "The unit price of an offer for the indicated channel, when the Channel Pricing feature is activated.
\nCan be empty when no specific price is defined for a given channel. In this case, the base price of the offer applies to the indicated channel.\n" }, "producer-id[EPR category code]": { "type": "string", "description": "Producer identifier of the eco-contribution for the EPR category. Returned if Data collection related to circular economy regulations is enabled.\n
Not present if the producer identifier belongs to the operator.", "maxLength": 255 }, "product-sku": { "type": "string", "description": "Product identifier within the operator's system" }, "product-tax-code": { "type": "string", "description": "Tax code for the product" }, "professional": { "type": "boolean", "description": "Indicates if the store is professional or not" }, "quantity": { "type": "integer", "format": "int32", "description": "Offer quantity available" }, "retail-price": { "type": "number", "format": "with decimals", "description": "Offer current retail price (original retail price or discount retail price if in discount period). Also referred to as selling price.
\nApplicable only for Dropship offers.\n" }, "shipping-price-additional[zone=,method=]": { "type": "number", "format": "with decimals", "description": "Additional shipping charges for the offer, for each combination of shipping zone and method.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "shipping-price-type[zone=,method=]": { "type": "string", "description": "Shipping charges type for the offer, for each combination of shipping zone and method.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n\n\nEnum: `\"FREE_SHIPPING\"`, `\"FIXED_PRICE\"`, `\"ORDER_PRICE_RANGE\"`\n" }, "shipping-price[zone=,method=]": { "type": "number", "format": "with decimals", "description": "Shipping charges for the offer, for each combination of shipping zone and method.
\nReturned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.\n" }, "shop-id": { "type": "integer", "format": "int64", "description": "Unique identifier for the store providing this offer (assigned by Mirakl)" }, "shop-name": { "type": "string", "description": "Name of the store providing this offer" }, "shop-sku": { "type": "string", "description": "Shop's sku of the offer" }, "state-code": { "type": "string", "description": "Offer condition code" }, "total-price": { "type": "number", "format": "with decimals", "description": "Offer price + minimum shipping charge
\nFor Dropship specifically: the purchasing price of the offer + minimum shipping charge\n" } } }, "OF61_Response_200": { "type": "object", "properties": { "offer_states": { "type": "array", "description": "Offer conditions", "items": { "$ref": "#/components/schemas/OF61_Response_200_OfferStates" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count (no pagination)" } }, "required": [ "offer_states", "total_count" ] }, "OF61_Response_200_OfferStates": { "type": "object", "properties": { "code": { "type": "string", "description": "Offer condition code" }, "label": { "type": "string", "description": "Offer condition label " } }, "required": [ "code", "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 } }, "required": [ "orders" ] }, "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" } }, "required": [ "order_id" ] }, "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" } }, "required": [ "order_line_id" ] }, "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", "format": "with decimals", "description": "Unit amount of the eco-contribution", "maximum": 100000000000000000, "minimum": 0 } }, "required": [ "epr_category_code", "producer_id" ] }, "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" } }, "required": [ "code", "field", "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.
Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } } }, "OR04_Response_200_UpdatedOrders_Updated_OrderLines_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.
Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } } }, "OR04_Response_200_UpdatedOrders_Updated_OrderLines_Refunds": { "type": "object", "properties": { "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_Refunds_EcoContributions" } }, "refund_id": { "type": "string", "description": "Refund identifier" } } }, "OR04_Response_200_UpdatedOrders_Updated_OrderLines_Refunds_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.
Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } } }, "OR04_Response_200_UpdatedOrders_Updated_References": { "type": "object", "properties": { "order_reference_for_seller": { "type": "string", "description": "Order reference for seller" } } }, "OR07_Request": { "type": "object", "properties": { "order_lines": { "type": "array", "description": "Order lines to be updated, maximum number of order lines per call: 100", "items": { "$ref": "#/components/schemas/OR07_Request_OrderLines" }, "maxItems": 100, "minItems": 1 } }, "required": [ "order_lines" ] }, "OR07_Request_OrderLines": { "type": "object", "description": "Order lines to be updated, maximum number of order lines per call: 100", "properties": { "id": { "type": "string", "description": "Order line identifier" }, "shipping_from": { "$ref": "#/components/schemas/OR07_Request_OrderLines_ShippingFrom", "description": "Shipping origin (country, full address or warehouse) of the order line" } }, "required": [ "id", "shipping_from" ] }, "OR07_Request_OrderLines_ShippingFrom": { "type": "object", "description": "Shipping origin (country, full address or warehouse) of the order line", "properties": { "address": { "$ref": "#/components/schemas/OR07_Request_OrderLines_ShippingFrom_Address", "description": "The address from where the offer is shipped" }, "warehouse": { "$ref": "#/components/schemas/OR07_Request_OrderLines_ShippingFrom_Warehouse", "description": "The warehouse from where the offer is shipped" } } }, "OR07_Request_OrderLines_ShippingFrom_Address": { "type": "object", "description": "The address from where the offer is shipped", "properties": { "city": { "type": "string", "description": "Address City" }, "country_iso_code": { "type": "string", "description": "Address Country ISO 3166-1 alpha-3 code (3 letters country code)" }, "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, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay" } }, "required": [ "country_iso_code" ] }, "OR07_Request_OrderLines_ShippingFrom_Warehouse": { "type": "object", "description": "The warehouse from where the offer is shipped", "properties": { "code": { "type": "string", "description": "The code of the warehouse" } } }, "OR07_Response_200": { "type": "object", "properties": { "order_lines": { "type": "array", "description": "A list containing each order line of the request, stating if the update was performed or failed.", "items": { "$ref": "#/components/schemas/OR07_Response_200_OrderLines" } } } }, "OR07_Response_200_OrderLines": { "type": "object", "properties": { "errors": { "type": "array", "description": "List of errors encountered when updating the shipping_from data on order line", "items": { "$ref": "#/components/schemas/OR07_Response_200_OrderLines_Errors" } }, "id": { "type": "string", "description": "Order line identifier" }, "updated": { "$ref": "#/components/schemas/OR07_Response_200_OrderLines_Updated", "description": "Updated shipping origin (country, full address or warehouse) of the order line" } }, "required": [ "id" ] }, "OR07_Response_200_OrderLines_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" } }, "required": [ "code", "field", "message" ] }, "OR07_Response_200_OrderLines_Updated": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/OR07_Response_200_OrderLines_Updated_Address", "description": "The address from where the offer is shipped" }, "warehouse": { "$ref": "#/components/schemas/OR07_Response_200_OrderLines_Updated_Warehouse", "description": "The warehouse from where the offer is shipped" } } }, "OR07_Response_200_OrderLines_Updated_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address City" }, "country_iso_code": { "type": "string", "description": "Address Country ISO 3166-1 alpha-3 code (3 letters country code)" }, "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" } }, "required": [ "country_iso_code" ] }, "OR07_Response_200_OrderLines_Updated_Warehouse": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the warehouse" } } }, "OR11_Response_200": { "type": "object", "properties": { "orders": { "type": "array", "description": "List of orders", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders" } }, "total_count": { "type": "integer", "format": "int32", "description": "Total count of orders" } }, "required": [ "orders", "total_count" ] }, "OR11_Response_200_Orders": { "type": "object", "properties": { "acceptance_decision_date": { "type": "string", "format": "date-time", "description": "The date where the shop decided to accept or refuse the order. Null when the order was automatically refused or accepted." }, "can_cancel": { "type": "boolean", "description": "Indicate if the order can be cancelled" }, "can_shop_ship": { "type": "boolean", "description": "Indicates if shops can or cannot ship orders" }, "channel": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Channel", "description": "The channel of the commercial's order" }, "commercial_id": { "type": "string", "description": "Commercial order's identifier" }, "created_date": { "type": "string", "format": "date-time", "description": "Order's creation date" }, "currency_iso_code": { "type": "string", "description": "Shop's currency (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "customer": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer", "description": "Information of the customer who ordered" }, "customer_debited_date": { "type": "string", "format": "date-time", "description": "The payment's date of the order by the customer" }, "customer_directly_pays_seller": { "type": "boolean", "description": "True if order is paid directly to seller. False otherwise." }, "customer_notification_email": { "type": "string", "description": "Anonymized customer email usable for notifications that do not expect an answer" }, "delivery_date": { "$ref": "#/components/schemas/OR11_Response_200_Orders_DeliveryDate", "description": "Expected order delivery date" }, "discount_campaigns": { "type": "array", "description": "List of discount campaigns applied to one or more order lines in this order.
This field aggregates all unique discount campaigns present across all order lines.
Empty or absent if no discount campaigns were applied to any order line.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_DiscountCampaigns" } }, "fulfillment": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Fulfillment", "description": "Fulfillment information" }, "fully_refunded": { "type": "boolean", "description": "Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines." }, "has_customer_message": { "type": "boolean", "description": "Indicate if the customer has sent a message related to this order" }, "has_incident": { "type": "boolean", "description": "Indicate if order has incident on at least one order line" }, "has_invoice": { "type": "boolean", "description": "Is an invoice available for this order." }, "invoice_details": { "$ref": "#/components/schemas/OR11_Response_200_Orders_InvoiceDetails", "description": "Invoice information linked to the order" }, "last_updated_date": { "type": "string", "format": "date-time", "description": "Order's last updated date" }, "leadtime_to_ship": { "type": "integer", "format": "int32", "deprecated": true, "description": "Order's lead time to ship, in calendar days." }, "order_additional_fields": { "type": "array", "description": "Order's custom fields", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } }, "order_id": { "type": "string", "description": "Order's identifier" }, "order_lines": { "type": "array", "description": "Order lines", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines" } }, "order_refunds": { "type": "array", "description": "The list of refunds aggregated by group identifier
Available when feature ‘order level tax calculation’ is enabled", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderRefunds" } }, "order_state": { "type": "string", "description": "Order's state\n\nEnum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
\n" }, "order_state_reason_code": { "type": "string", "description": "Reason's code of the order state" }, "order_state_reason_label": { "type": "string", "description": "Reason's label of the order state " }, "order_tax_mode": { "type": "string", "description": "Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the order.
Possible values:
  • 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.
\n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" }, "order_taxes": { "type": "array", "description": "Total amount of taxes aggregated per tax code and rate
Available when feature ‘order level tax calculation’ is enabled", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderTaxes" } }, "paymentType": { "type": "string", "deprecated": true, "description": "Warning: this field has been replaced by payment_type and will be removed soon." }, "payment_duration": { "type": "integer", "format": "int32", "description": "The payment's duration (i.e. the delay after which the order is supposed to be paid), in days.
Only applicable for PAY_ON_DUE_DATE orders, null otherwise.
Note that this field has currently no impact on the order workflow, it is provided for information purposes." }, "payment_type": { "type": "string", "description": "The payment's type used by the customer to pay this order" }, "payment_workflow": { "type": "string", "description": "The payment workflow followed by the order\n\nEnum: `\"PAY_ON_ACCEPTANCE\"`, `\"PAY_ON_DELIVERY\"`, `\"PAY_ON_DUE_DATE\"`, `\"PAY_ON_SHIPMENT\"`, `\"NO_CUSTOMER_PAYMENT_CONFIRMATION\"`\n" }, "price": { "type": "number", "format": "with decimals", "description": "Order's price (sum of order line's price)" }, "promotions": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Promotions", "description": "Promotions' summary applied to the order" }, "quote_id": { "type": "string", "description": "Quote's id from which the order has been placed, or null if it was not from a quote" }, "references": { "$ref": "#/components/schemas/OR11_Response_200_Orders_References", "description": "Order references" }, "shipping_carrier_code": { "type": "string", "description": "Shipping carrier code (associated with the Shipping company label)" }, "shipping_carrier_standard_code": { "type": "string", "description": "Shipping carrier standard code (associated with the shipping carrier code)" }, "shipping_company": { "type": "string", "description": "Shipping company" }, "shipping_deadline": { "type": "string", "format": "date-time", "description": "Order's shipping deadline" }, "shipping_price": { "type": "number", "format": "with decimals", "description": "Order's shipping price (sum of order line's shipping price)" }, "shipping_pudo_id": { "type": "string", "description": "PickUp DropOff (PUDO) point identifier" }, "shipping_tracking": { "type": "string", "description": "Shipping tracking" }, "shipping_tracking_url": { "type": "string", "description": "Shipping tracking url" }, "shipping_type_code": { "type": "string", "description": "Code of shipping's type" }, "shipping_type_label": { "type": "string", "description": "Label of shipping's type " }, "shipping_type_standard_code": { "type": "string", "description": "Shipping type's standard code" }, "shipping_zone_code": { "type": "string", "description": "Code of shipping's zone" }, "shipping_zone_label": { "type": "string", "description": "Label of shipping's zone " }, "total_commission": { "type": "number", "format": "with decimals", "description": "Order's total commission (sum of the order line's total commission)" }, "total_price": { "type": "number", "format": "with decimals", "description": "Total order's price (sum of the order's price with shipping price and fees)." }, "transaction_date": { "type": "string", "format": "date-time", "description": "Payment's transaction date" }, "transaction_number": { "type": "string", "description": "Payment's transaction number" } }, "required": [ "can_cancel", "can_shop_ship", "commercial_id", "created_date", "currency_iso_code", "customer", "fulfillment", "fully_refunded", "has_customer_message", "has_incident", "has_invoice", "last_updated_date", "leadtime_to_ship", "order_id", "order_lines", "order_state", "order_tax_mode", "paymentType", "price", "shipping_price", "shipping_type_code", "shipping_type_label", "shipping_zone_code", "shipping_zone_label", "total_commission", "total_price" ] }, "OR11_Response_200_Orders_Channel": { "type": "object", "properties": { "code": { "type": "string", "description": "Channel code" }, "label": { "type": "string", "description": "Channel label " } }, "required": [ "code", "label" ] }, "OR11_Response_200_Orders_Customer": { "type": "object", "properties": { "accounting_contact": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer_AccountingContact", "description": "Data related to the accounting contact in the organization.
Null before shipping (or acceptance, depending on platform setting)." }, "billing_address": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer_BillingAddress", "description": "Customer's billing address.
Null before shipping (or acceptance, depending on platform setting)." }, "civility": { "type": "string", "description": "Customer's civility" }, "customer_id": { "type": "string", "description": "Customer's identifier" }, "delivery_contact": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer_DeliveryContact", "description": "Data related to the delivery contact in the organization.
Null before shipping (or acceptance, depending on platform setting)." }, "firstname": { "type": "string", "description": "Customer's first name" }, "lastname": { "type": "string", "description": "Customer's last name" }, "locale": { "type": "string", "description": "Customer's locale" }, "organization": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer_Organization", "description": "Data related to the organization that created the order (B2B transactions)" }, "shipping_address": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer_ShippingAddress", "description": "Customer's Shipping address.
Null before shipping (or acceptance, depending on platform setting)." } }, "required": [ "billing_address", "customer_id", "firstname", "lastname", "shipping_address" ] }, "OR11_Response_200_Orders_Customer_AccountingContact": { "type": "object", "properties": { "civility": { "type": "string", "description": "Customer contact's civility", "maxLength": 20 }, "customer_id": { "type": "string", "description": "Customer contact's identifier", "maxLength": 50 }, "firstname": { "type": "string", "description": "Customer contact's firstname", "maxLength": 255 }, "lastname": { "type": "string", "description": "Customer contact's lastname", "maxLength": 255 }, "locale": { "type": "string", "description": "Customer contact's locale" } }, "required": [ "customer_id", "firstname", "lastname" ] }, "OR11_Response_200_Orders_Customer_BillingAddress": { "type": "object", "properties": { "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\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "OR11_Response_200_Orders_Customer_DeliveryContact": { "type": "object", "properties": { "civility": { "type": "string", "description": "Customer contact's civility", "maxLength": 20 }, "customer_id": { "type": "string", "description": "Customer contact's identifier", "maxLength": 50 }, "firstname": { "type": "string", "description": "Customer contact's firstname", "maxLength": 255 }, "lastname": { "type": "string", "description": "Customer contact's lastname", "maxLength": 255 }, "locale": { "type": "string", "description": "Customer contact's locale" } }, "required": [ "customer_id", "firstname", "lastname" ] }, "OR11_Response_200_Orders_Customer_Organization": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Customer_Organization_Address", "description": "Address of the organization. Required for new organizations.
Null before shipping (or acceptance, depending on platform setting)." }, "electronic_address": { "type": "string", "description": "Identifier of the customer organization used to route and deliver e-invoices. It is also known as 'Routing Identifier' or 'PEPPOL Participant ID'
Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 }, "identification_number": { "type": "string", "description": "Number used to identify the customer organization as an established business in a country. E.g: SIRET number in France, NIF in Spain. Required for new organizations.
Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 }, "name": { "type": "string", "description": "Name of the organization. Required for new organizations.", "maxLength": 255 }, "organization_id": { "type": "string", "description": "Customer's organization id (from the operator's system).
Null before shipping (or acceptance, depending on platform setting).", "maxLength": 50 }, "phone_number": { "type": "string", "description": "Phone number of the customer organization
Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the organization.
Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 } }, "required": [ "organization_id" ] }, "OR11_Response_200_Orders_Customer_Organization_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address city", "maxLength": 255 }, "country_iso_code": { "type": "string", "description": "Country ISO 3166-1 code of the address, 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)\n\nEnum: `\"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\"`\n" }, "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 } }, "required": [ "city", "country_iso_code", "street_1", "zip_code" ] }, "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\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "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" } }, "required": [ "earliest", "latest" ] }, "OR11_Response_200_Orders_DiscountCampaigns": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The unique identifier of the discount campaign" } }, "required": [ "identifier" ] }, "OR11_Response_200_Orders_Fulfillment": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Fulfillment_Center", "description": "Fulfillment center code" } }, "required": [ "center" ] }, "OR11_Response_200_Orders_Fulfillment_Center": { "type": "object", "properties": { "code": { "type": "string", "description": "Center code" } }, "required": [ "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\n\nEnum: `\"PDF\"`, `\"cXML\"`\n" } } }, "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.
Possible values:
  • 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.
\n\nEnum: `\"END_OF_MONTH\"`, `\"NET\"`\n" } }, "required": [ "days", "type" ] }, "OR11_Response_200_Orders_OrderAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_Boolean", "DATE": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_Date", "LINK": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_Link", "LIST": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_Regex", "STRING": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines": { "type": "object", "properties": { "can_refund": { "type": "boolean", "description": "Indicate whether the order line full amount can be refunded" }, "cancelations": { "type": "array", "description": "List of the cancellations", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations" } }, "category_code": { "type": "string", "description": "Category code of the product associated with the order line" }, "category_label": { "type": "string", "description": "Category label of the product associated with the order line " }, "commission_fee": { "type": "number", "format": "with decimals", "description": "Order line's commission fee" }, "commission_rate_vat": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Commission tax rate applied for the order line

Please use commission_taxes instead. If multi-taxes are applied to this order, this field will return the rate of the first tax applied." }, "commission_taxes": { "type": "array", "description": "Commission taxes", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_CommissionTaxes" } }, "commission_vat": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Commission tax of the order line

Please use commission_taxes instead. If multi-taxes are applied to this order, this field will return the amount of the first tax applied." }, "created_date": { "type": "string", "format": "date-time", "description": "Order line's creation date" }, "debited_date": { "type": "string", "format": "date-time", "description": "Order line's debited date" }, "description": { "type": "string", "description": "Order line's description" }, "discount_campaign": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_DiscountCampaign", "description": "The discount campaign that was applied to this order line" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
\nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees applied on the order line", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Fees" } }, "last_updated_date": { "type": "string", "format": "date-time", "description": "Order line's last updated date" }, "measurement": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Measurement", "description": "Measurement information of the order line" }, "offer_id": { "type": "integer", "format": "int64", "description": "Associated offer's id" }, "offer_sku": { "type": "string", "description": "Associated offer sku (this is the sku of the offer defined by the shop)" }, "offer_state_code": { "type": "string", "description": "State of the offer associated with the order line" }, "order_line_additional_fields": { "type": "array", "description": "List of custom fields", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } }, "order_line_id": { "type": "string", "description": "Order line's identifier" }, "order_line_index": { "type": "integer", "format": "int32", "description": "Order line's index in the order" }, "order_line_state": { "type": "string", "description": "Order line's state\n\nEnum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`, `\"INCIDENT_OPEN\"`, `\"REFUNDED\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
\n" }, "order_line_state_reason_code": { "type": "string", "description": "Reason's code of the order line's state" }, "order_line_state_reason_label": { "type": "string", "description": "Reason's label of the order line's state " }, "origin_unit_price": { "type": "number", "format": "with decimals", "description": "The original unit price of the offer associated with the order line" }, "price": { "type": "number", "format": "with decimals", "description": "Order line's price without shipping price" }, "price_additional_info": { "type": "string", "description": "Price's additional information of the offer" }, "price_amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown", "description": "The breakdown of the price, only available when advanced features are enabled" }, "price_unit": { "type": "number", "format": "with decimals", "description": "Unit price for the offer associated with the order line" }, "product_medias": { "type": "array", "description": "List of all product's media associated to the order line", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ProductMedias" } }, "product_shop_sku": { "type": "string", "description": "Shop SKU of the product associated with the order line" }, "product_sku": { "type": "string", "description": "SKU of the product associated with the order line" }, "product_title": { "type": "string", "description": "Title of the product associated with the order line " }, "promotions": { "type": "array", "description": "List of promotions", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Promotions" } }, "purchase_information": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_PurchaseInformation", "description": "Purchase information
\nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "Product's quantity for the order line" }, "received_date": { "type": "string", "format": "date-time", "description": "Product's date of receipt" }, "refunds": { "type": "array", "description": "List of the refunds", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds" } }, "shipped_date": { "type": "string", "format": "date-time", "description": "Order line's shipped date" }, "shipping_from": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingFrom", "description": "Shipping origin (country, full address or warehouse) of the order line" }, "shipping_price": { "type": "number", "format": "with decimals", "description": "Total price of the order line's shipping price" }, "shipping_price_additional_unit": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Additional price of the shipping price unit" }, "shipping_price_amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown", "description": "The breakdown of the shipping price, only available when advanced features are enabled" }, "shipping_price_unit": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Unit price of the shipping price" }, "shipping_taxes": { "type": "array", "description": "List of taxes applied on shipping charges", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingTaxes" } }, "tax_legal_notice": { "type": "string", "description": "The legal notice applying to the order line’s taxes" }, "taxes": { "type": "array", "description": "List of taxes applied on product price", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Taxes" } }, "total_commission": { "type": "number", "format": "with decimals", "description": "Order line's total commission (sum of the commission fee and the commission vat)" }, "total_price": { "type": "number", "format": "with decimals", "description": "Order line's price with shipping price and fees." } }, "required": [ "can_refund", "cancelations", "category_code", "category_label", "commission_fee", "commission_rate_vat", "commission_vat", "created_date", "description", "last_updated_date", "offer_id", "offer_sku", "offer_state_code", "order_line_additional_fields", "order_line_id", "order_line_index", "order_line_state", "price", "price_unit", "product_medias", "product_sku", "product_title", "quantity", "refunds", "shipping_price", "total_commission", "total_price" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Cancellation's amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown", "description": "The breakdown of the cancellation's amount, only available when advanced features are enabled" }, "commission_amount": { "type": "number", "format": "with decimals", "description": "Cancellation's commission amount" }, "commission_taxes": { "type": "array", "description": "Cancellation's commission taxes", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_CommissionTaxes" } }, "commission_total_amount": { "type": "number", "format": "with decimals", "description": "The total commission amount of the cancellation (commission amount + commission taxes)" }, "created_date": { "type": "string", "format": "date-time", "description": "Cancellation's creation date" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
\nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees canceled on the order line", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Fees" } }, "id": { "type": "string", "description": "Cancellation's id" }, "purchase_information": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation", "description": "Cancelation’s purchase information
\nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of products canceled (This quantity is informative only)" }, "reason_code": { "type": "string", "description": "Cancellation reason's code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "Cancellation's shipping amount" }, "shipping_amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown", "description": "The breakdown of the cancellation's shipping amount, only available when advanced features are enabled" }, "shipping_taxes": { "type": "array", "description": "The taxes on the shipping price", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes" } }, "taxes": { "type": "array", "description": "The taxes on the price", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Taxes" } } }, "required": [ "commission_amount", "commission_taxes", "commission_total_amount", "created_date", "id" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_CommissionTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_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.
Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Fee amount" }, "code": { "type": "string", "description": "Fee code" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees", "description": "Cancelation’s purchase commission total amount on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount", "description": "Cancelation’s purchase fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase shipping charges" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase fee total amount" } }, "required": [ "total_amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR11_Response_200_Orders_OrderLines_CommissionTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate, as a percentage (between 0 and 100)" } }, "required": [ "amount", "code", "rate" ] }, "OR11_Response_200_Orders_OrderLines_DiscountCampaign": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The unique identifier of the discount campaign" } }, "required": [ "identifier" ] }, "OR11_Response_200_Orders_OrderLines_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.
Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR11_Response_200_Orders_OrderLines_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Fee amount" }, "code": { "type": "string", "description": "Fee code" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Measurement": { "type": "object", "properties": { "actual_measurement": { "type": "number", "format": "with decimals", "description": "Actual measurement on the order line" }, "adjustment_limit": { "type": "number", "format": "with decimals", "description": "Adjustment limit of the order line" }, "measurement_unit": { "type": "string", "description": "Measurement unit of the order line\n\nEnum: `\"GRAM\"`, `\"KILOGRAM\"`, `\"TON\"`, `\"POUND\"`, `\"OUNCE\"`, `\"MILLILITER\"`, `\"CENTILITER\"`, `\"CUBIC_METER\"`, `\"LITER\"`, `\"GALLON\"`, `\"FLUID_OUNCE\"`, `\"PINT\"`, `\"BARREL\"`, `\"CENTIMETER\"`, `\"METER\"`, `\"INCH\"`, `\"FEET\"`, `\"SQUARE_CENTIMETER\"`, `\"SQUARE_METER\"`, `\"SQUARE_INCH\"`, `\"SQUARE_FOOT\"`, `\"PIECE\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"USgal\"`, `\"bbl\"`, `\"cl\"`, `\"cm\"`, `\"cm2\"`, `\"floz\"`, `\"ft\"`, `\"ft2\"`, `\"g\"`, `\"in\"`, `\"in2\"`, `\"kg\"`, `\"l\"`, `\"lb\"`, `\"m\"`, `\"m2\"`, `\"m3\"`, `\"ml\"`, `\"oz\"`, `\"pt\"`, `\"t\"`\n
\n" }, "ordered_measurement": { "type": "number", "format": "with decimals", "description": "Total measurement ordered on the order line" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Boolean", "DATE": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Date", "LINK": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Link", "LIST": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Regex", "STRING": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_ProductMedias": { "type": "object", "properties": { "media_url": { "type": "string", "description": "Media URL" }, "mime_type": { "type": "string", "description": "Media MIME Type (.jpg, .png ...)" }, "type": { "type": "string", "description": "Media TYPE (small, large...)" } }, "required": [ "media_url", "mime_type", "type" ] }, "OR11_Response_200_Orders_OrderLines_Promotions": { "type": "object", "properties": { "apportioned": { "type": "boolean", "description": "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", "format": "with decimals", "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.
Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "promo_code": { "type": "string", "description": "Promo code associated to the promotion" } }, "required": [ "apportioned", "configuration", "deduced_amount", "id" ] }, "OR11_Response_200_Orders_OrderLines_Promotions_Campaign": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The identifier of the promotion campaign." } }, "required": [ "identifier" ] }, "OR11_Response_200_Orders_OrderLines_Promotions_Configuration": { "type": "object", "properties": { "amount_off": { "type": "number", "format": "with decimals", "description": "The amount off of the promotion.
Only applicable when promotion is of type AMOUNT_OFF, null otherwise." }, "free_items_quantity": { "type": "integer", "format": "int32", "description": "The free item target quantity of the promotion.
Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "internal_description": { "type": "string", "description": "Promotion's Internal description, set by the shop at creation" }, "percentage_off": { "type": "number", "format": "with decimals", "description": "The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise." }, "reduced_unit_price": { "type": "number", "format": "with decimals", "description": "The new offer’s unit price triggered by the promotion.
Only applicable when promotion is of type 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)\n\nEnum: `\"AMOUNT_OFF\"`, `\"FREE_ITEMS\"`, `\"PERCENTAGE_OFF\"`, `\"REDUCED_UNIT_PRICE\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"ALL\"`\n
\n" } }, "required": [ "internal_description", "type" ] }, "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", "format": "with decimals", "description": "Purchase order line’s commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "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", "format": "with decimals", "description": "Purchase order line’s price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Purchase order line’s shipping charges" }, "purchase_unit_price": { "type": "number", "format": "with decimals", "description": "Purchase unit price computed from the given offer price" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price", "purchase_unit_price" ] }, "OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Purchase order line’s commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Purchase order line’s fee total amount" } }, "required": [ "total_amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "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", "format": "with decimals", "description": "Refund's commission amount" }, "commission_tax_amount": { "type": "number", "format": "with decimals", "deprecated": true, "description": "The commission tax amount of the refund

Please use commission_taxes instead. If multi-taxes are applied to this refund, this field will return the amount of the first tax applied." }, "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", "format": "with decimals", "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 applicable
\nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees refunded on the order line", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Fees" } }, "id": { "type": "string", "description": "Refund's id" }, "order_refund_id": { "type": "string", "description": "The group identifier of the refunds created at the same time on the order" }, "purchase_information": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation", "description": "Refund’s purchase information
\nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of products refunded (This quantity is informative only)." }, "reason_code": { "type": "string", "description": "Reason's code of the refund" }, "refund_state": { "type": "string", "description": "Refund's state\n\nEnum: `\"WAITING_REFUND_TAX_CONFIRMATION\"`, `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`, `\"REFUNDED\"`\n" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "Refund's shipping amount" }, "shipping_amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown", "description": "The breakdown of the refund's shipping amount, only available when advanced features are enabled" }, "shipping_taxes": { "type": "array", "description": "The taxes on the shipping price", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes" } }, "state": { "type": "string", "deprecated": true, "description": "

Refund's state

Warning: This field has been deprecated and will not contain newer states added to refunds. Use refund_state instead

\n\nEnum: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`, `\"REFUNDED\"`\n" }, "tax_legal_notice": { "type": "string", "description": "The legal notice applying to the refunded order line’s taxes" }, "taxes": { "type": "array", "description": "The taxes on the price", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Taxes" } }, "transaction_date": { "type": "string", "format": "date-time", "description": "The transaction date of the refund payment" }, "transaction_number": { "type": "string", "description": "The transaction number of the refund payment" } }, "required": [ "commission_amount", "commission_tax_amount", "commission_taxes", "commission_total_amount", "created_date", "id", "order_refund_id", "quantity", "reason_code", "refund_state", "state" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_CommissionTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_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.
Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Fee amount" }, "code": { "type": "string", "description": "Fee code" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees", "description": "Refund’s purchase commission amount on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount", "description": "Refund’s purchase fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase shipping charges" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Refund’s purchase fee total amount" } }, "required": [ "total_amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR11_Response_200_Orders_OrderLines_ShippingFrom": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingFrom_Address", "description": "The address from where the offer is shipped" }, "warehouse": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingFrom_Warehouse", "description": "The warehouse from where the offer is shipped" } } }, "OR11_Response_200_Orders_OrderLines_ShippingFrom_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address City" }, "country_iso_code": { "type": "string", "description": "Address Country ISO 3166-1 alpha-3 code (3 letters country code)" }, "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" } }, "required": [ "country_iso_code" ] }, "OR11_Response_200_Orders_OrderLines_ShippingFrom_Warehouse": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the warehouse" } } }, "OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" }, "tax_calculation_rule": { "type": "string", "description": "The type of automated calculation done during a partial refund or cancellation.
Possible values:
- none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.
- proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation.\n\nEnum: `\"PROPORTIONAL_TO_AMOUNT\"`, `\"NONE\"`\n" } }, "required": [ "amount", "code", "tax_calculation_rule" ] }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR11_Response_200_Orders_OrderLines_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "origin_unit_amount": { "type": "number", "format": "with decimals", "description": "The original tax amount of the offer associated with the order line before a discount or a promotion" }, "purchase_tax": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" }, "tax_calculation_rule": { "type": "string", "description": "The type of automated calculation done during a partial refund or cancellation.
Possible values:
- none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.
- proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation.\n\nEnum: `\"PROPORTIONAL_TO_AMOUNT\"`, `\"NONE\"`\n" } }, "required": [ "amount", "code", "tax_calculation_rule" ] }, "OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
If true, the amount is taken into account when generating the debit file.
If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
If true, the amount is taken into account when generating the shop payment voucher.
If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR11_Response_200_Orders_OrderLines_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR11_Response_200_Orders_OrderRefunds": { "type": "object", "properties": { "order_refund_id": { "type": "string", "description": "The group identifier of the refunds created at the same time on the order" }, "taxes": { "type": "array", "description": "Total amount of refunded taxes aggregated per tax code and rate", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_OrderRefunds_Taxes" } } }, "required": [ "order_refund_id" ] }, "OR11_Response_200_Orders_OrderRefunds_Taxes": { "type": "object", "properties": { "code": { "type": "string", "description": "Order tax code" }, "rate": { "type": "number", "format": "with decimals", "description": "Order tax rate" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Order total refunded tax amount for product and shipping, for a defined tax code and rate" } }, "required": [ "code", "total_amount" ] }, "OR11_Response_200_Orders_OrderTaxes": { "type": "object", "properties": { "code": { "type": "string", "description": "Order tax code" }, "rate": { "type": "number", "format": "with decimals", "description": "Order tax rate" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Order total tax amount for product and shipping, for a defined tax code and rate" } }, "required": [ "code", "total_amount" ] }, "OR11_Response_200_Orders_Promotions": { "type": "object", "properties": { "applied_promotions": { "type": "array", "description": "The promotions applied on this order", "items": { "$ref": "#/components/schemas/OR11_Response_200_Orders_Promotions_AppliedPromotions" } }, "total_deduced_amount": { "type": "number", "format": "with decimals", "description": "The total amount deduced on this order thanks to the promotions" } }, "required": [ "applied_promotions", "total_deduced_amount" ] }, "OR11_Response_200_Orders_Promotions_AppliedPromotions": { "type": "object", "properties": { "apportioned": { "type": "boolean", "description": "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_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", "format": "with decimals", "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.
Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "promo_code": { "type": "string", "description": "Promo code associated to the promotion" } }, "required": [ "apportioned", "configuration", "deduced_amount", "id" ] }, "OR11_Response_200_Orders_Promotions_AppliedPromotions_Campaign": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The identifier of the promotion campaign." } }, "required": [ "identifier" ] }, "OR11_Response_200_Orders_Promotions_AppliedPromotions_Configuration": { "type": "object", "properties": { "amount_off": { "type": "number", "format": "with decimals", "description": "The amount off of the promotion.
Only applicable when promotion is of type AMOUNT_OFF, null otherwise." }, "free_items_quantity": { "type": "integer", "format": "int32", "description": "The free item target quantity of the promotion.
Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "internal_description": { "type": "string", "description": "Promotion's Internal description, set by the shop at creation" }, "percentage_off": { "type": "number", "format": "with decimals", "description": "The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise." }, "reduced_unit_price": { "type": "number", "format": "with decimals", "description": "The new offer’s unit price triggered by the promotion.
Only applicable when promotion is of type 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)\n\nEnum: `\"AMOUNT_OFF\"`, `\"FREE_ITEMS\"`, `\"PERCENTAGE_OFF\"`, `\"REDUCED_UNIT_PRICE\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"ALL\"`\n
\n" } }, "required": [ "internal_description", "type" ] }, "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" } } }, "OR12_Response_200": { "type": "object", "properties": { "acceptance_decision_date": { "type": "string", "format": "date-time", "description": "The date when the shop decided to accept or refuse the order" }, "commercial_id": { "type": "string", "description": "Commercial's identifier of the order" }, "created_date": { "type": "string", "format": "date-time", "description": "Order's creation date" }, "customer": { "$ref": "#/components/schemas/OR12_Response_200_Customer", "description": "Information of the customer who ordered" }, "has_customer_message": { "type": "boolean", "description": "Indicate if the customer has sent a message related to this order" }, "has_incident": { "type": "boolean", "description": "Indicate if order has an incident on at least one order line" }, "has_invoice": { "type": "boolean", "description": "Is an invoice available for this order." }, "last_updated_date": { "type": "string", "format": "date-time", "description": "Last update date of the order" }, "order_id": { "type": "string", "description": "Order's identifier" }, "order_lines": { "type": "array", "description": "Order lines", "items": { "$ref": "#/components/schemas/OR12_Response_200_OrderLines" } }, "order_state": { "type": "string", "description": "Order's state\n\nEnum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
\n" }, "order_state_reason_code": { "type": "string", "description": "Reason code of the order state" }, "order_state_reason_label": { "type": "string", "description": "Reason label of the order state" }, "paymentType": { "type": "string", "deprecated": true, "description": "

Payment's type used by the customer to pay this order

This field has been replaced by \"payment_type\" and will be removed soon.

" }, "payment_type": { "type": "string", "description": "Payment's type used by the customer to pay this order" }, "price": { "type": "number", "format": "with decimals", "description": "Order's price (sum of order line price)" }, "shipping_company": { "type": "string", "description": "Shipping company" }, "shipping_price": { "type": "number", "format": "with decimals", "description": "Order's shipping price (sum of order line shipping price)" }, "shipping_tracking": { "type": "string", "description": "Shipping tracking" }, "shipping_tracking_url": { "type": "string", "description": "Shipping tracking url" }, "shipping_type_code": { "type": "string", "description": "Code of shipping's type" }, "shipping_type_label": { "type": "string", "description": "Label of shipping's type" }, "shipping_zone_code": { "type": "string", "description": "Code of shipping's zone" }, "shipping_zone_label": { "type": "string", "description": "Label of shipping's zone" }, "total_commission": { "type": "number", "format": "with decimals", "description": "Order's total commission (sum of the order line total commission)" }, "total_price": { "type": "number", "format": "with decimals", "description": "Order's total price (sum of the order price and the order shipping price)" } }, "required": [ "acceptance_decision_date", "commercial_id", "created_date", "has_customer_message", "has_incident", "has_invoice", "last_updated_date", "order_id", "order_lines", "order_state", "order_state_reason_code", "order_state_reason_label", "paymentType", "payment_type", "price", "shipping_price", "shipping_type_code", "shipping_type_label", "shipping_zone_code", "shipping_zone_label", "total_commission", "total_price" ] }, "OR12_Response_200_Customer": { "type": "object", "properties": { "billing_address": { "$ref": "#/components/schemas/OR12_Response_200_Customer_BillingAddress" }, "civility": { "type": "string" }, "customer_id": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "shipping_address": { "$ref": "#/components/schemas/OR12_Response_200_Customer_ShippingAddress" } }, "required": [ "billing_address", "customer_id", "firstname", "lastname", "shipping_address" ] }, "OR12_Response_200_Customer_BillingAddress": { "type": "object", "properties": { "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" }, "country": { "type": "string", "description": "Address country" }, "country_iso_code": { "type": "string", "description": "Country ISO 3166-1 code of the address\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "OR12_Response_200_Customer_ShippingAddress": { "type": "object", "properties": { "additional_info": { "type": "string" }, "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" }, "country": { "type": "string", "description": "Address country" }, "country_iso_code": { "type": "string", "description": "Country ISO 3166-1 code of the address\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "OR12_Response_200_OrderLines": { "type": "object", "properties": { "can_refund": { "type": "boolean" }, "category_code": { "type": "string" }, "category_label": { "type": "string" }, "commission_fee": { "type": "number", "format": "with decimals" }, "commission_rate_vat": { "type": "number", "format": "with decimals" }, "commission_vat": { "type": "number", "format": "with decimals" }, "created_date": { "type": "string", "format": "date-time" }, "debited_date": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "last_updated_date": { "type": "string", "format": "date-time" }, "offer_id": { "type": "integer", "format": "int64" }, "offer_sku": { "type": "string" }, "offer_state_code": { "type": "string" }, "order_line_additional_fields": { "type": "array", "items": { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } }, "order_line_id": { "type": "string" }, "order_line_index": { "type": "integer", "format": "int32" }, "order_line_state": { "type": "string", "description": "Order line's state\n\nEnum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`, `\"INCIDENT_OPEN\"`, `\"REFUNDED\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
\n" }, "order_line_state_reason_code": { "type": "string" }, "order_line_state_reason_label": { "type": "string" }, "price": { "type": "number", "format": "with decimals" }, "price_additional_info": { "type": "string" }, "price_unit": { "type": "number", "format": "with decimals" }, "product_sku": { "type": "string" }, "product_title": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "received_date": { "type": "string", "format": "date-time" }, "shipped_date": { "type": "string", "format": "date-time" }, "shipping_price": { "type": "number", "format": "with decimals" }, "shipping_price_additional_unit": { "type": "number", "format": "with decimals", "deprecated": true }, "shipping_price_unit": { "type": "number", "format": "with decimals", "deprecated": true }, "total_commission": { "type": "number", "format": "with decimals" }, "total_price": { "type": "number", "format": "with decimals" } }, "required": [ "can_refund", "category_code", "category_label", "commission_fee", "commission_rate_vat", "commission_vat", "created_date", "debited_date", "description", "last_updated_date", "offer_id", "offer_sku", "offer_state_code", "order_line_additional_fields", "order_line_id", "order_line_index", "order_line_state", "order_line_state_reason_code", "order_line_state_reason_label", "price", "price_unit", "product_sku", "product_title", "quantity", "received_date", "shipped_date", "shipping_price", "shipping_price_additional_unit", "shipping_price_unit", "total_commission", "total_price" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_Boolean", "DATE": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_Date", "LINK": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_Link", "LIST": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_Regex", "STRING": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR12_Response_200_OrderLines_OrderLineAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR12_Response_200_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "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", "description": "Enum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`\n\n
\n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
\n" }, "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.
Possible values:
  • 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.
  • If this query parameter is not specified, the default order tax mode of the platform is used.
    • \n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" }, "start_date": { "type": "string", "format": "date-time", "description": "Start order creation date for filtering. Must be used with 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" } }, "required": [ "tracking_id" ] }, "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" } } }, "required": [ "last_updated", "status" ] }, "OR15_Response_200_Ext_FileStructure": { "type": "object", "properties": { "orders": { "type": "array", "description": "List of orders", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders" } } }, "required": [ "orders" ] }, "OR15_Response_200_Ext_FileStructure_Orders": { "type": "object", "properties": { "acceptance_decision_date": { "type": "string", "format": "date-time", "description": "The date where the shop decided to accept or refuse the order. Null when the order was automatically refused or accepted." }, "can_cancel": { "type": "boolean", "description": "Indicate if the order can be cancelled" }, "can_shop_ship": { "type": "boolean", "description": "Indicates if shops can or cannot ship orders" }, "channel": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Channel", "description": "The channel of the commercial's order" }, "commercial_id": { "type": "string", "description": "Commercial order's identifier" }, "created_date": { "type": "string", "format": "date-time", "description": "Order's creation date" }, "currency_iso_code": { "type": "string", "description": "Shop's currency (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "customer": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer", "description": "Information of the customer who ordered" }, "customer_debited_date": { "type": "string", "format": "date-time", "description": "The payment's date of the order by the customer" }, "customer_directly_pays_seller": { "type": "boolean", "description": "True if order is paid directly to seller. False otherwise." }, "customer_notification_email": { "type": "string", "description": "Anonymized customer email usable for notifications that do not expect an answer" }, "delivery_date": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_DeliveryDate", "description": "Expected order delivery date" }, "discount_campaigns": { "type": "array", "description": "List of discount campaigns applied to one or more order lines in this order.
    This field aggregates all unique discount campaigns present across all order lines.
    Empty or absent if no discount campaigns were applied to any order line.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_DiscountCampaigns" } }, "fulfillment": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Fulfillment", "description": "Fulfillment information" }, "fully_refunded": { "type": "boolean", "description": "Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines." }, "has_customer_message": { "type": "boolean", "description": "Indicate if the customer has sent a message related to this order" }, "has_incident": { "type": "boolean", "description": "Indicate if order has incident on at least one order line" }, "has_invoice": { "type": "boolean", "description": "Is an invoice available for this order." }, "invoice_details": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails", "description": "Invoice information linked to the order" }, "last_updated_date": { "type": "string", "format": "date-time", "description": "Order's last updated date" }, "leadtime_to_ship": { "type": "integer", "format": "int32", "deprecated": true, "description": "Order's lead time to ship, in calendar days." }, "order_additional_fields": { "type": "array", "description": "Order's custom fields", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } }, "order_id": { "type": "string", "description": "Order's identifier" }, "order_lines": { "type": "array", "description": "Order lines", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines" } }, "order_refunds": { "type": "array", "description": "The list of refunds aggregated by group identifier
    Available when feature ‘order level tax calculation’ is enabled", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderRefunds" } }, "order_state": { "type": "string", "description": "Order's state\n\nEnum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
    \n" }, "order_state_reason_code": { "type": "string", "description": "Reason's code of the order state" }, "order_state_reason_label": { "type": "string", "description": "Reason's label of the order state " }, "order_tax_mode": { "type": "string", "description": "Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the order.
    Possible values:
    • 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.
    \n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" }, "order_taxes": { "type": "array", "description": "Total amount of taxes aggregated per tax code and rate
    Available when feature ‘order level tax calculation’ is enabled", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderTaxes" } }, "paymentType": { "type": "string", "deprecated": true, "description": "Warning: this field has been replaced by payment_type and will be removed soon." }, "payment_duration": { "type": "integer", "format": "int32", "description": "The payment's duration (i.e. the delay after which the order is supposed to be paid), in days.
    Only applicable for PAY_ON_DUE_DATE orders, null otherwise.
    Note that this field has currently no impact on the order workflow, it is provided for information purposes." }, "payment_type": { "type": "string", "description": "The payment's type used by the customer to pay this order" }, "payment_workflow": { "type": "string", "description": "The payment workflow followed by the order\n\nEnum: `\"PAY_ON_ACCEPTANCE\"`, `\"PAY_ON_DELIVERY\"`, `\"PAY_ON_DUE_DATE\"`, `\"PAY_ON_SHIPMENT\"`, `\"NO_CUSTOMER_PAYMENT_CONFIRMATION\"`\n" }, "price": { "type": "number", "format": "with decimals", "description": "Order's price (sum of order line's price)" }, "promotions": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Promotions", "description": "Promotions' summary applied to the order" }, "quote_id": { "type": "string", "description": "Quote's id from which the order has been placed, or null if it was not from a quote" }, "references": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_References", "description": "Order references" }, "shipping_carrier_code": { "type": "string", "description": "Shipping carrier code (associated with the Shipping company label)" }, "shipping_carrier_standard_code": { "type": "string", "description": "Shipping carrier standard code (associated with the shipping carrier code)" }, "shipping_company": { "type": "string", "description": "Shipping company" }, "shipping_deadline": { "type": "string", "format": "date-time", "description": "Order's shipping deadline" }, "shipping_price": { "type": "number", "format": "with decimals", "description": "Order's shipping price (sum of order line's shipping price)" }, "shipping_pudo_id": { "type": "string", "description": "PickUp DropOff (PUDO) point identifier" }, "shipping_tracking": { "type": "string", "description": "Shipping tracking" }, "shipping_tracking_url": { "type": "string", "description": "Shipping tracking url" }, "shipping_type_code": { "type": "string", "description": "Code of shipping's type" }, "shipping_type_label": { "type": "string", "description": "Label of shipping's type " }, "shipping_type_standard_code": { "type": "string", "description": "Shipping type's standard code" }, "shipping_zone_code": { "type": "string", "description": "Code of shipping's zone" }, "shipping_zone_label": { "type": "string", "description": "Label of shipping's zone " }, "total_commission": { "type": "number", "format": "with decimals", "description": "Order's total commission (sum of the order line's total commission)" }, "total_price": { "type": "number", "format": "with decimals", "description": "Total order's price (sum of the order's price with shipping price and fees)." }, "transaction_date": { "type": "string", "format": "date-time", "description": "Payment's transaction date" }, "transaction_number": { "type": "string", "description": "Payment's transaction number" } }, "required": [ "can_cancel", "can_shop_ship", "commercial_id", "created_date", "currency_iso_code", "customer", "fulfillment", "fully_refunded", "has_customer_message", "has_incident", "has_invoice", "last_updated_date", "leadtime_to_ship", "order_id", "order_lines", "order_state", "order_tax_mode", "paymentType", "price", "shipping_price", "shipping_type_code", "shipping_type_label", "shipping_zone_code", "shipping_zone_label", "total_commission", "total_price" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Channel": { "type": "object", "properties": { "code": { "type": "string", "description": "Channel code" }, "label": { "type": "string", "description": "Channel label " } }, "required": [ "code", "label" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Customer": { "type": "object", "properties": { "accounting_contact": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer_AccountingContact", "description": "Data related to the accounting contact in the organization.
    Null before shipping (or acceptance, depending on platform setting)." }, "billing_address": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer_BillingAddress", "description": "Customer's billing address.
    Null before shipping (or acceptance, depending on platform setting)." }, "civility": { "type": "string", "description": "Customer's civility" }, "customer_id": { "type": "string", "description": "Customer's identifier" }, "delivery_contact": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer_DeliveryContact", "description": "Data related to the delivery contact in the organization.
    Null before shipping (or acceptance, depending on platform setting)." }, "firstname": { "type": "string", "description": "Customer's first name" }, "lastname": { "type": "string", "description": "Customer's last name" }, "locale": { "type": "string", "description": "Customer's locale" }, "organization": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization", "description": "Data related to the organization that created the order (B2B transactions)" }, "shipping_address": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer_ShippingAddress", "description": "Customer's Shipping address.
    Null before shipping (or acceptance, depending on platform setting)." } }, "required": [ "billing_address", "customer_id", "firstname", "lastname", "shipping_address" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Customer_AccountingContact": { "type": "object", "properties": { "civility": { "type": "string", "description": "Customer contact's civility", "maxLength": 20 }, "customer_id": { "type": "string", "description": "Customer contact's identifier", "maxLength": 50 }, "firstname": { "type": "string", "description": "Customer contact's firstname", "maxLength": 255 }, "lastname": { "type": "string", "description": "Customer contact's lastname", "maxLength": 255 }, "locale": { "type": "string", "description": "Customer contact's locale" } }, "required": [ "customer_id", "firstname", "lastname" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Customer_BillingAddress": { "type": "object", "properties": { "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\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Customer_DeliveryContact": { "type": "object", "properties": { "civility": { "type": "string", "description": "Customer contact's civility", "maxLength": 20 }, "customer_id": { "type": "string", "description": "Customer contact's identifier", "maxLength": 50 }, "firstname": { "type": "string", "description": "Customer contact's firstname", "maxLength": 255 }, "lastname": { "type": "string", "description": "Customer contact's lastname", "maxLength": 255 }, "locale": { "type": "string", "description": "Customer contact's locale" } }, "required": [ "customer_id", "firstname", "lastname" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization_Address", "description": "Address of the organization. Required for new organizations.
    Null before shipping (or acceptance, depending on platform setting)." }, "electronic_address": { "type": "string", "description": "Identifier of the customer organization used to route and deliver e-invoices. It is also known as 'Routing Identifier' or 'PEPPOL Participant ID'
    Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 }, "identification_number": { "type": "string", "description": "Number used to identify the customer organization as an established business in a country. E.g: SIRET number in France, NIF in Spain. Required for new organizations.
    Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 }, "name": { "type": "string", "description": "Name of the organization. Required for new organizations.", "maxLength": 255 }, "organization_id": { "type": "string", "description": "Customer's organization id (from the operator's system).
    Null before shipping (or acceptance, depending on platform setting).", "maxLength": 50 }, "phone_number": { "type": "string", "description": "Phone number of the customer organization
    Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 }, "tax_identification_number": { "type": "string", "description": "Tax identification number of the organization.
    Null before shipping (or acceptance, depending on platform setting).", "maxLength": 255 } }, "required": [ "organization_id" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Customer_Organization_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address city", "maxLength": 255 }, "country_iso_code": { "type": "string", "description": "Country ISO 3166-1 code of the address, 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)\n\nEnum: `\"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\"`\n" }, "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 } }, "required": [ "city", "country_iso_code", "street_1", "zip_code" ] }, "OR15_Response_200_Ext_FileStructure_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\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "OR15_Response_200_Ext_FileStructure_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" } }, "required": [ "earliest", "latest" ] }, "OR15_Response_200_Ext_FileStructure_Orders_DiscountCampaigns": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The unique identifier of the discount campaign" } }, "required": [ "identifier" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Fulfillment": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Fulfillment_Center", "description": "Fulfillment center code" } }, "required": [ "center" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Fulfillment_Center": { "type": "object", "properties": { "code": { "type": "string", "description": "Center code" } }, "required": [ "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails": { "type": "object", "properties": { "document_details": { "type": "array", "description": "Invoice document information", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails_DocumentDetails" } }, "payment_terms": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails_PaymentTerms", "description": "Payment terms" } } }, "OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails_DocumentDetails": { "type": "object", "properties": { "format": { "type": "string", "description": "Accounting document format\n\nEnum: `\"PDF\"`, `\"cXML\"`\n" } } }, "OR15_Response_200_Ext_FileStructure_Orders_InvoiceDetails_PaymentTerms": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32", "description": "Number of days" }, "type": { "type": "string", "description": "Payment terms type.
    Possible values:
    • 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.
    \n\nEnum: `\"END_OF_MONTH\"`, `\"NET\"`\n" } }, "required": [ "days", "type" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Boolean", "DATE": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Date", "LINK": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Link", "LIST": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Regex", "STRING": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines": { "type": "object", "properties": { "can_refund": { "type": "boolean", "description": "Indicate whether the order line full amount can be refunded" }, "cancelations": { "type": "array", "description": "List of the cancellations", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations" } }, "category_code": { "type": "string", "description": "Category code of the product associated with the order line" }, "category_label": { "type": "string", "description": "Category label of the product associated with the order line " }, "commission_fee": { "type": "number", "format": "with decimals", "description": "Order line's commission fee" }, "commission_rate_vat": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Commission tax rate applied for the order line

    Please use commission_taxes instead. If multi-taxes are applied to this order, this field will return the rate of the first tax applied." }, "commission_taxes": { "type": "array", "description": "Commission taxes", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_CommissionTaxes" } }, "commission_vat": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Commission tax of the order line

    Please use commission_taxes instead. If multi-taxes are applied to this order, this field will return the amount of the first tax applied." }, "created_date": { "type": "string", "format": "date-time", "description": "Order line's creation date" }, "debited_date": { "type": "string", "format": "date-time", "description": "Order line's debited date" }, "description": { "type": "string", "description": "Order line's description" }, "discount_campaign": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_DiscountCampaign", "description": "The discount campaign that was applied to this order line" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees applied on the order line", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Fees" } }, "last_updated_date": { "type": "string", "format": "date-time", "description": "Order line's last updated date" }, "measurement": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Measurement", "description": "Measurement information of the order line" }, "offer_id": { "type": "integer", "format": "int64", "description": "Associated offer's id" }, "offer_sku": { "type": "string", "description": "Associated offer sku (this is the sku of the offer defined by the shop)" }, "offer_state_code": { "type": "string", "description": "State of the offer associated with the order line" }, "order_line_additional_fields": { "type": "array", "description": "List of custom fields", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } }, "order_line_id": { "type": "string", "description": "Order line's identifier" }, "order_line_index": { "type": "integer", "format": "int32", "description": "Order line's index in the order" }, "order_line_state": { "type": "string", "description": "Order line's state\n\nEnum: `\"STAGING\"`, `\"WAITING_ACCEPTANCE\"`, `\"WAITING_DEBIT\"`, `\"WAITING_DEBIT_PAYMENT\"`, `\"SHIPPING\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CLOSED\"`, `\"REFUSED\"`, `\"CANCELED\"`, `\"INCIDENT_OPEN\"`, `\"REFUNDED\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`\n
    \n" }, "order_line_state_reason_code": { "type": "string", "description": "Reason's code of the order line's state" }, "order_line_state_reason_label": { "type": "string", "description": "Reason's label of the order line's state " }, "origin_unit_price": { "type": "number", "format": "with decimals", "description": "The original unit price of the offer associated with the order line" }, "price": { "type": "number", "format": "with decimals", "description": "Order line's price without shipping price" }, "price_additional_info": { "type": "string", "description": "Price's additional information of the offer" }, "price_amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PriceAmountBreakdown", "description": "The breakdown of the price, only available when advanced features are enabled" }, "price_unit": { "type": "number", "format": "with decimals", "description": "Unit price for the offer associated with the order line" }, "product_medias": { "type": "array", "description": "List of all product's media associated to the order line", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ProductMedias" } }, "product_shop_sku": { "type": "string", "description": "Shop SKU of the product associated with the order line" }, "product_sku": { "type": "string", "description": "SKU of the product associated with the order line" }, "product_title": { "type": "string", "description": "Title of the product associated with the order line " }, "promotions": { "type": "array", "description": "List of promotions", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions" } }, "purchase_information": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation", "description": "Purchase information
    \nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "Product's quantity for the order line" }, "received_date": { "type": "string", "format": "date-time", "description": "Product's date of receipt" }, "refunds": { "type": "array", "description": "List of the refunds", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds" } }, "shipped_date": { "type": "string", "format": "date-time", "description": "Order line's shipped date" }, "shipping_from": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom", "description": "Shipping origin (country, full address or warehouse) of the order line" }, "shipping_price": { "type": "number", "format": "with decimals", "description": "Total price of the order line's shipping price" }, "shipping_price_additional_unit": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Additional price of the shipping price unit" }, "shipping_price_amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingPriceAmountBreakdown", "description": "The breakdown of the shipping price, only available when advanced features are enabled" }, "shipping_price_unit": { "type": "number", "format": "with decimals", "deprecated": true, "description": "Unit price of the shipping price" }, "shipping_taxes": { "type": "array", "description": "List of taxes applied on shipping charges", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes" } }, "tax_legal_notice": { "type": "string", "description": "The legal notice applying to the order line’s taxes" }, "taxes": { "type": "array", "description": "List of taxes applied on product price", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes" } }, "total_commission": { "type": "number", "format": "with decimals", "description": "Order line's total commission (sum of the commission fee and the commission vat)" }, "total_price": { "type": "number", "format": "with decimals", "description": "Order line's price with shipping price and fees." } }, "required": [ "can_refund", "cancelations", "category_code", "category_label", "commission_fee", "commission_rate_vat", "commission_vat", "created_date", "description", "last_updated_date", "offer_id", "offer_sku", "offer_state_code", "order_line_additional_fields", "order_line_id", "order_line_index", "order_line_state", "price", "price_unit", "product_medias", "product_sku", "product_title", "quantity", "refunds", "shipping_price", "total_commission", "total_price" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Cancellation's amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_AmountBreakdown", "description": "The breakdown of the cancellation's amount, only available when advanced features are enabled" }, "commission_amount": { "type": "number", "format": "with decimals", "description": "Cancellation's commission amount" }, "commission_taxes": { "type": "array", "description": "Cancellation's commission taxes", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_CommissionTaxes" } }, "commission_total_amount": { "type": "number", "format": "with decimals", "description": "The total commission amount of the cancellation (commission amount + commission taxes)" }, "created_date": { "type": "string", "format": "date-time", "description": "Cancellation's creation date" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees canceled on the order line", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Fees" } }, "id": { "type": "string", "description": "Cancellation's id" }, "purchase_information": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation", "description": "Cancelation’s purchase information
    \nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of products canceled (This quantity is informative only)" }, "reason_code": { "type": "string", "description": "Cancellation reason's code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "Cancellation's shipping amount" }, "shipping_amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingAmountBreakdown", "description": "The breakdown of the cancellation's shipping amount, only available when advanced features are enabled" }, "shipping_taxes": { "type": "array", "description": "The taxes on the shipping price", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes" } }, "taxes": { "type": "array", "description": "The taxes on the price", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes" } } }, "required": [ "commission_amount", "commission_taxes", "commission_total_amount", "created_date", "id" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_CommissionTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Fee amount" }, "code": { "type": "string", "description": "Fee code" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees", "description": "Cancelation’s purchase commission total amount on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount", "description": "Cancelation’s purchase fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase shipping charges" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase fee total amount" } }, "required": [ "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Cancelations_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_CommissionTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate, as a percentage (between 0 and 100)" } }, "required": [ "amount", "code", "rate" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_DiscountCampaign": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The unique identifier of the discount campaign" } }, "required": [ "identifier" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Fee amount" }, "code": { "type": "string", "description": "Fee code" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Measurement": { "type": "object", "properties": { "actual_measurement": { "type": "number", "format": "with decimals", "description": "Actual measurement on the order line" }, "adjustment_limit": { "type": "number", "format": "with decimals", "description": "Adjustment limit of the order line" }, "measurement_unit": { "type": "string", "description": "Measurement unit of the order line\n\nEnum: `\"GRAM\"`, `\"KILOGRAM\"`, `\"TON\"`, `\"POUND\"`, `\"OUNCE\"`, `\"MILLILITER\"`, `\"CENTILITER\"`, `\"CUBIC_METER\"`, `\"LITER\"`, `\"GALLON\"`, `\"FLUID_OUNCE\"`, `\"PINT\"`, `\"BARREL\"`, `\"CENTIMETER\"`, `\"METER\"`, `\"INCH\"`, `\"FEET\"`, `\"SQUARE_CENTIMETER\"`, `\"SQUARE_METER\"`, `\"SQUARE_INCH\"`, `\"SQUARE_FOOT\"`, `\"PIECE\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"USgal\"`, `\"bbl\"`, `\"cl\"`, `\"cm\"`, `\"cm2\"`, `\"floz\"`, `\"ft\"`, `\"ft2\"`, `\"g\"`, `\"in\"`, `\"in2\"`, `\"kg\"`, `\"l\"`, `\"lb\"`, `\"m\"`, `\"m2\"`, `\"m3\"`, `\"ml\"`, `\"oz\"`, `\"pt\"`, `\"t\"`\n
    \n" }, "ordered_measurement": { "type": "number", "format": "with decimals", "description": "Total measurement ordered on the order line" } } }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Boolean", "DATE": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Date", "LINK": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Link", "LIST": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Regex", "STRING": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PriceAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PriceAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PriceAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ProductMedias": { "type": "object", "properties": { "media_url": { "type": "string", "description": "Media URL" }, "mime_type": { "type": "string", "description": "Media MIME Type (.jpg, .png ...)" }, "type": { "type": "string", "description": "Media TYPE (small, large...)" } }, "required": [ "media_url", "mime_type", "type" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions": { "type": "object", "properties": { "apportioned": { "type": "boolean", "description": "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/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions_Campaign", "description": "Promotion campaign information, when applicable." }, "configuration": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions_Configuration", "description": "Configuration used to calculate the applied promotion" }, "deduced_amount": { "type": "number", "format": "with decimals", "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.
    Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "promo_code": { "type": "string", "description": "Promo code associated to the promotion" } }, "required": [ "apportioned", "configuration", "deduced_amount", "id" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions_Campaign": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The identifier of the promotion campaign." } }, "required": [ "identifier" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Promotions_Configuration": { "type": "object", "properties": { "amount_off": { "type": "number", "format": "with decimals", "description": "The amount off of the promotion.
    Only applicable when promotion is of type AMOUNT_OFF, null otherwise." }, "free_items_quantity": { "type": "integer", "format": "int32", "description": "The free item target quantity of the promotion.
    Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "internal_description": { "type": "string", "description": "Promotion's Internal description, set by the shop at creation" }, "percentage_off": { "type": "number", "format": "with decimals", "description": "The percentage off of the promotion.
    Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise." }, "reduced_unit_price": { "type": "number", "format": "with decimals", "description": "The new offer’s unit price triggered by the promotion.
    Only applicable when promotion is of type 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)\n\nEnum: `\"AMOUNT_OFF\"`, `\"FREE_ITEMS\"`, `\"PERCENTAGE_OFF\"`, `\"REDUCED_UNIT_PRICE\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"ALL\"`\n
    \n" } }, "required": [ "internal_description", "type" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees", "description": "Purchase order line’s commission on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Purchase order line’s commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Purchase order line’s commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount", "description": "Purchase order line’s fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Purchase order line’s price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Purchase order line’s shipping charges" }, "purchase_unit_price": { "type": "number", "format": "with decimals", "description": "Purchase unit price computed from the given offer price" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price", "purchase_unit_price" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Purchase order line’s commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Purchase order line’s fee total amount" } }, "required": [ "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Refund's amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_AmountBreakdown", "description": "The breakdown of the refund's amount, only available when advanced features are enabled" }, "commission_amount": { "type": "number", "format": "with decimals", "description": "Refund's commission amount" }, "commission_tax_amount": { "type": "number", "format": "with decimals", "deprecated": true, "description": "The commission tax amount of the refund

    Please use commission_taxes instead. If multi-taxes are applied to this refund, this field will return the amount of the first tax applied." }, "commission_taxes": { "type": "array", "description": "Refund's commission taxes", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_CommissionTaxes" } }, "commission_total_amount": { "type": "number", "format": "with decimals", "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 applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees refunded on the order line", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Fees" } }, "id": { "type": "string", "description": "Refund's id" }, "order_refund_id": { "type": "string", "description": "The group identifier of the refunds created at the same time on the order" }, "purchase_information": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation", "description": "Refund’s purchase information
    \nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of products refunded (This quantity is informative only)." }, "reason_code": { "type": "string", "description": "Reason's code of the refund" }, "refund_state": { "type": "string", "description": "Refund's state\n\nEnum: `\"WAITING_REFUND_TAX_CONFIRMATION\"`, `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`, `\"REFUNDED\"`\n" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "Refund's shipping amount" }, "shipping_amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingAmountBreakdown", "description": "The breakdown of the refund's shipping amount, only available when advanced features are enabled" }, "shipping_taxes": { "type": "array", "description": "The taxes on the shipping price", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes" } }, "state": { "type": "string", "deprecated": true, "description": "

    Refund's state

    Warning: This field has been deprecated and will not contain newer states added to refunds. Use refund_state instead

    \n\nEnum: `\"WAITING_REFUND\"`, `\"WAITING_REFUND_PAYMENT\"`, `\"REFUNDED\"`\n" }, "tax_legal_notice": { "type": "string", "description": "The legal notice applying to the refunded order line’s taxes" }, "taxes": { "type": "array", "description": "The taxes on the price", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes" } }, "transaction_date": { "type": "string", "format": "date-time", "description": "The transaction date of the refund payment" }, "transaction_number": { "type": "string", "description": "The transaction number of the refund payment" } }, "required": [ "commission_amount", "commission_tax_amount", "commission_taxes", "commission_total_amount", "created_date", "id", "order_refund_id", "quantity", "reason_code", "refund_state", "state" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_CommissionTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Fee amount" }, "code": { "type": "string", "description": "Fee code" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees", "description": "Refund’s purchase commission amount on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount", "description": "Refund’s purchase fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase shipping charges" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Refund’s purchase fee total amount" } }, "required": [ "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Refunds_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom_Address", "description": "The address from where the offer is shipped" }, "warehouse": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom_Warehouse", "description": "The warehouse from where the offer is shipped" } } }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom_Address": { "type": "object", "properties": { "city": { "type": "string", "description": "Address City" }, "country_iso_code": { "type": "string", "description": "Address Country ISO 3166-1 alpha-3 code (3 letters country code)" }, "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" } }, "required": [ "country_iso_code" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingFrom_Warehouse": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the warehouse" } } }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingPriceAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" }, "tax_calculation_rule": { "type": "string", "description": "The type of automated calculation done during a partial refund or cancellation.
    Possible values:
    - none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.
    - proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation.\n\nEnum: `\"PROPORTIONAL_TO_AMOUNT\"`, `\"NONE\"`\n" } }, "required": [ "amount", "code", "tax_calculation_rule" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "origin_unit_amount": { "type": "number", "format": "with decimals", "description": "The original tax amount of the offer associated with the order line before a discount or a promotion" }, "purchase_tax": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" }, "tax_calculation_rule": { "type": "string", "description": "The type of automated calculation done during a partial refund or cancellation.
    Possible values:
    - none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.
    - proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation.\n\nEnum: `\"PROPORTIONAL_TO_AMOUNT\"`, `\"NONE\"`\n" } }, "required": [ "amount", "code", "tax_calculation_rule" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderLines_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderRefunds": { "type": "object", "properties": { "order_refund_id": { "type": "string", "description": "The group identifier of the refunds created at the same time on the order" }, "taxes": { "type": "array", "description": "Total amount of refunded taxes aggregated per tax code and rate", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_OrderRefunds_Taxes" } } }, "required": [ "order_refund_id" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderRefunds_Taxes": { "type": "object", "properties": { "code": { "type": "string", "description": "Order tax code" }, "rate": { "type": "number", "format": "with decimals", "description": "Order tax rate" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Order total refunded tax amount for product and shipping, for a defined tax code and rate" } }, "required": [ "code", "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_OrderTaxes": { "type": "object", "properties": { "code": { "type": "string", "description": "Order tax code" }, "rate": { "type": "number", "format": "with decimals", "description": "Order tax rate" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Order total tax amount for product and shipping, for a defined tax code and rate" } }, "required": [ "code", "total_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Promotions": { "type": "object", "properties": { "applied_promotions": { "type": "array", "description": "The promotions applied on this order", "items": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions" } }, "total_deduced_amount": { "type": "number", "format": "with decimals", "description": "The total amount deduced on this order thanks to the promotions" } }, "required": [ "applied_promotions", "total_deduced_amount" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions": { "type": "object", "properties": { "apportioned": { "type": "boolean", "description": "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/OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions_Campaign", "description": "Promotion campaign information, when applicable." }, "configuration": { "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions_Configuration", "description": "Configuration used to calculate the applied promotion" }, "deduced_amount": { "type": "number", "format": "with decimals", "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.
    Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "promo_code": { "type": "string", "description": "Promo code associated to the promotion" } }, "required": [ "apportioned", "configuration", "deduced_amount", "id" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions_Campaign": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The identifier of the promotion campaign." } }, "required": [ "identifier" ] }, "OR15_Response_200_Ext_FileStructure_Orders_Promotions_AppliedPromotions_Configuration": { "type": "object", "properties": { "amount_off": { "type": "number", "format": "with decimals", "description": "The amount off of the promotion.
    Only applicable when promotion is of type AMOUNT_OFF, null otherwise." }, "free_items_quantity": { "type": "integer", "format": "int32", "description": "The free item target quantity of the promotion.
    Only applicable when promotion is of type FREE_ITEMS, null otherwise." }, "internal_description": { "type": "string", "description": "Promotion's Internal description, set by the shop at creation" }, "percentage_off": { "type": "number", "format": "with decimals", "description": "The percentage off of the promotion.
    Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise." }, "reduced_unit_price": { "type": "number", "format": "with decimals", "description": "The new offer’s unit price triggered by the promotion.
    Only applicable when promotion is of type 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)\n\nEnum: `\"AMOUNT_OFF\"`, `\"FREE_ITEMS\"`, `\"PERCENTAGE_OFF\"`, `\"REDUCED_UNIT_PRICE\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"ALL\"`\n
    \n" } }, "required": [ "internal_description", "type" ] }, "OR15_Response_200_Ext_FileStructure_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" } } }, "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" } } }, "required": [ "order_lines" ] }, "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" } }, "required": [ "accepted", "id" ] }, "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." } } }, "OR26_Request": { "type": "object", "properties": { "order_lines": { "type": "array", "description": "List of order line's representations", "items": { "$ref": "#/components/schemas/OR26_Request_OrderLines" } } }, "required": [ "order_lines" ] }, "OR26_Request_OrderLines": { "type": "object", "description": "List of order line's representations", "properties": { "id": { "type": "string", "description": "The identifier of the order line that must be refunded" }, "reason_code": { "type": "string", "description": "Refund reason code" } }, "required": [ "id", "reason_code" ] }, "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.
    Possible values:
    • 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.
    • If not specified, the default order tax mode of the platform is used.
    \n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" }, "refunds": { "type": "array", "description": "List of representations of refunds to be created", "items": { "$ref": "#/components/schemas/OR28_Request_Refunds" } } }, "required": [ "refunds" ] }, "OR28_Request_Refunds": { "type": "object", "description": "List of representations of refunds to be created", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The offer part amount to be refunded." }, "currency_iso_code": { "type": "string", "description": "The currency (iso format) used by the shop (the field is required if the shop is not using the default Operator platform currency)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "excluded_from_shipment": { "type": "boolean", "description": "Exclude the refunded quantity from shipments" }, "fees": { "type": "array", "description": "The fee part amount to be refunded", "items": { "$ref": "#/components/schemas/OR28_Request_Refunds_Fees" } }, "order_line_id": { "type": "string", "description": "The identifier of the order line that must be refunded" }, "quantity": { "type": "integer", "format": "int32", "default": 0, "description": "The quantity of products to refund. This quantity is informative only." }, "reason_code": { "type": "string", "description": "Refund's reason code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "The shipping charges part amount to be refunded" }, "shipping_taxes": { "type": "array", "description": "The taxes to be refunded on the shipping price
    This field is required if the order has shipping taxes.", "items": { "$ref": "#/components/schemas/OR28_Request_Refunds_ShippingTaxes" } }, "taxes": { "type": "array", "description": "The taxes to be refunded on the product price
    This field is required if the order has taxes.", "items": { "$ref": "#/components/schemas/OR28_Request_Refunds_Taxes" } } }, "required": [ "amount", "order_line_id", "reason_code", "shipping_amount" ] }, "OR28_Request_Refunds_Fees": { "type": "object", "description": "The fee part amount to be refunded", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Order Fee amount" }, "code": { "type": "string", "description": "Order Fee code" } } }, "OR28_Request_Refunds_ShippingTaxes": { "type": "object", "description": "The taxes to be refunded on the shipping price
    This field is required if the order has shipping taxes.", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR28_Request_Refunds_Taxes": { "type": "object", "description": "The taxes to be refunded on the shipping price
    This field is required if the order has shipping taxes.", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR28_Response_200": { "type": "object", "properties": { "order_tax_mode": { "type": "string", "description": "Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the refund.
    Possible values:
    • 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.
    \n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" }, "refunds": { "type": "array", "description": "List of representations of created refunds", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds" } } }, "required": [ "order_tax_mode", "refunds" ] }, "OR28_Response_200_Refunds": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The offer part amount of the refund" }, "amount_breakdown": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_AmountBreakdown", "description": "The breakdown of the offer part amount to be refunded, only available when advanced features are enabled" }, "currency_iso_code": { "type": "string", "description": "The currency (iso format) used by the shop (the field is required if the shop is not using the default Operator platform currency)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_EcoContributions" } }, "excluded_from_shipment": { "type": "boolean", "description": "Exclude the refunded quantity from shipments" }, "fees": { "type": "array", "description": "List of fees refunded on the order line", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_Fees" } }, "order_line_id": { "type": "string", "description": "The identifier of the order line on which the refund has been created" }, "order_refund_id": { "type": "string", "description": "The group identifier of the refunds created at the same time on the order" }, "purchase_information": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_PurchaseInformation", "description": "Refund’s purchase information" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of goods to refund" }, "reason_code": { "type": "string", "description": "Refund's reason code" }, "refund_id": { "type": "string", "description": "The identifier of the created refund" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "The shipping charges part amount of the refund" }, "shipping_amount_breakdown": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_ShippingAmountBreakdown", "description": "The breakdown of the shipping charges to be refunded, only available when advanced features are enabled" }, "shipping_taxes": { "type": "array", "description": "List of taxes refunded on shipping charges", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_ShippingTaxes" } }, "taxes": { "type": "array", "description": "List of taxes refunded on product price", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_Taxes" } } }, "required": [ "amount", "order_line_id", "order_refund_id", "quantity", "reason_code", "refund_id", "shipping_amount" ] }, "OR28_Response_200_Refunds_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR28_Response_200_Refunds_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR28_Response_200_Refunds_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR28_Response_200_Refunds_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Order Fee amount" }, "code": { "type": "string", "description": "Order Fee code" } } }, "OR28_Response_200_Refunds_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_PurchaseInformation_PurchaseCommissionOnFees", "description": "Refund’s purchase commission amount on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_PurchaseInformation_PurchaseFeeAmount", "description": "Refund’s purchase fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Refund’s purchase shipping charges" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price" ] }, "OR28_Response_200_Refunds_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Refund’s purchase commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR28_Response_200_Refunds_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Refund’s purchase fee total amount" } }, "required": [ "total_amount" ] }, "OR28_Response_200_Refunds_ShippingAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_ShippingAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR28_Response_200_Refunds_ShippingAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR28_Response_200_Refunds_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR28_Response_200_Refunds_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR28_Response_200_Refunds_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR28_Response_200_Refunds_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR28_Response_200_Refunds_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR28_Response_200_Refunds_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR28_Response_200_Refunds_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR30_Request": { "type": "object", "properties": { "cancelations": { "type": "array", "description": "List of representations of cancellations to be created", "items": { "$ref": "#/components/schemas/OR30_Request_Cancelations" } }, "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.\n\nPossible values:\n- `TAX_EXCLUDED`: the price fields (price, unit price, shipping price and order total prices) do not include taxes.\n- `TAX_INCLUDED`: the price fields include the tax amounts.\n- If not specified, the default order tax mode of the platform is used.\n\nWhen the feature 'order level tax calculation' is enabled, the order_tax_mode provided must be the same as defined for the platform.\n\n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" } }, "required": [ "cancelations" ] }, "OR30_Request_Cancelations": { "type": "object", "description": "List of representations of cancellations to be created", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The offer part amount to be canceled" }, "currency_iso_code": { "type": "string", "description": "The currency (iso format) used by the shop (the field is required if the shop is not using the default Operator platform currency)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "fees": { "type": "array", "description": "The fees to be canceled", "items": { "$ref": "#/components/schemas/OR30_Request_Cancelations_Fees" } }, "order_line_id": { "type": "string", "description": "Order line's identifier that must be canceled" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of goods to cancel" }, "reason_code": { "type": "string", "description": "Cancellation's reason code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "The shipping charges part amount to be canceled" }, "shipping_taxes": { "type": "array", "description": "The taxes to be canceled on the shipping price (this field is required if the order has shipping taxes).\nWhen feature 'order level tax calculation' is enabled and used with TAX_EXCLUDED tax mode, field must not be provided.\n", "items": { "$ref": "#/components/schemas/OR30_Request_Cancelations_ShippingTaxes" } }, "taxes": { "type": "array", "description": "The taxes to be canceled on the product price (this field is required if the order has taxes).\nWhen feature 'order level tax calculation' is enabled and used with TAX_EXCLUDED tax mode, field must not be provided.\n", "items": { "$ref": "#/components/schemas/OR30_Request_Cancelations_Taxes" } } }, "required": [ "amount", "order_line_id", "quantity", "reason_code", "shipping_amount" ] }, "OR30_Request_Cancelations_Fees": { "type": "object", "description": "The fees to be canceled", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Order Fee amount" }, "code": { "type": "string", "description": "Order Fee code" } } }, "OR30_Request_Cancelations_ShippingTaxes": { "type": "object", "description": "The taxes to be canceled on the shipping price (this field is required if the order has shipping taxes).\nWhen feature 'order level tax calculation' is enabled and used with TAX_EXCLUDED tax mode, field must not be provided.\n", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR30_Request_Cancelations_Taxes": { "type": "object", "description": "The taxes to be canceled on the shipping price (this field is required if the order has shipping taxes).\nWhen feature 'order level tax calculation' is enabled and used with TAX_EXCLUDED tax mode, field must not be provided.\n", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR30_Response_200": { "type": "object", "properties": { "cancelations": { "type": "array", "description": "List of representations of created cancellations", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations" } }, "order_tax_mode": { "type": "string", "description": "Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the cancelation.
    Possible values:
    • 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.
    \n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" } }, "required": [ "cancelations", "order_tax_mode" ] }, "OR30_Response_200_Cancelations": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The offer part amount of the cancellation" }, "amount_breakdown": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_AmountBreakdown", "description": "The breakdown of the offer part amount to be canceled, only available when advanced features are enabled" }, "cancelation_id": { "type": "string", "description": "The identifier of the created cancellation" }, "currency_iso_code": { "type": "string", "description": "The currency (iso format) used by the shop (the field is required if the shop is not using the default Operator platform currency)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_EcoContributions" } }, "fees": { "type": "array", "description": "List of fees canceled on the order line", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_Fees" } }, "order_line_id": { "type": "string", "description": "Order line's identifier on which the cancellation has been created" }, "purchase_information": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_PurchaseInformation", "description": "Cancelation’s purchase information
    \nOnly available for One Creditor offers\n" }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of canceled goods" }, "reason_code": { "type": "string", "description": "Cancellation's reason code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "The shipping charges part amount of the cancellation" }, "shipping_amount_breakdown": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_ShippingAmountBreakdown", "description": "The breakdown of the shipping charges to be canceled, only available when advanced features are enabled" }, "shipping_taxes": { "type": "array", "description": "List of taxes canceled on shipping charges", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_ShippingTaxes" } }, "taxes": { "type": "array", "description": "List of taxes canceled on product price", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_Taxes" } } }, "required": [ "amount", "cancelation_id", "order_line_id", "reason_code", "shipping_amount" ] }, "OR30_Response_200_Cancelations_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR30_Response_200_Cancelations_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR30_Response_200_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR30_Response_200_Cancelations_Fees": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Order Fee amount" }, "code": { "type": "string", "description": "Order Fee code" } } }, "OR30_Response_200_Cancelations_PurchaseInformation": { "type": "object", "properties": { "purchase_commission_on_fees": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_PurchaseInformation_PurchaseCommissionOnFees", "description": "Cancelation’s purchase commission total amount on fees" }, "purchase_commission_on_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission amount" }, "purchase_commission_on_shipping": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission amount on shipping" }, "purchase_fee_amount": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_PurchaseInformation_PurchaseFeeAmount", "description": "Cancelation’s purchase fees" }, "purchase_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase shipping charges" } }, "required": [ "purchase_commission_on_price", "purchase_commission_on_shipping", "purchase_price", "purchase_shipping_price" ] }, "OR30_Response_200_Cancelations_PurchaseInformation_PurchaseCommissionOnFees": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase commission total amount on fees" } }, "required": [ "total_amount" ] }, "OR30_Response_200_Cancelations_PurchaseInformation_PurchaseFeeAmount": { "type": "object", "properties": { "total_amount": { "type": "number", "format": "with decimals", "description": "Cancelation’s purchase fee total amount" } }, "required": [ "total_amount" ] }, "OR30_Response_200_Cancelations_ShippingAmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_ShippingAmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR30_Response_200_Cancelations_ShippingAmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR30_Response_200_Cancelations_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_ShippingTaxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR30_Response_200_Cancelations_ShippingTaxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR30_Response_200_Cancelations_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "amount_breakdown": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_Taxes_AmountBreakdown", "description": "The breakdown of the tax amount, only available when advanced features are enabled" }, "code": { "type": "string", "description": "Tax code" }, "purchase_tax": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_Taxes_PurchaseTax", "description": "Purchase tax information" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } }, "required": [ "amount", "code" ] }, "OR30_Response_200_Cancelations_Taxes_AmountBreakdown": { "type": "object", "properties": { "parts": { "type": "array", "description": "The parts which constitute the total amount.
    Each part can have different invoicing rules. The sum of the amount of each part is equal to the total amount. Multiple parts can be returned in tax mode TAX_INCLUDED.", "items": { "$ref": "#/components/schemas/OR30_Response_200_Cancelations_Taxes_AmountBreakdown_Parts" }, "maxItems": 2147483647, "minItems": 1 } }, "required": [ "parts" ] }, "OR30_Response_200_Cancelations_Taxes_AmountBreakdown_Parts": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Part's amount. The sum of each part's amount is equal to the total amount.", "minimum": 0 }, "commissionable": { "type": "boolean", "description": "Should this amount be applied to the sellers commissions calculation." }, "debitable_from_customer": { "type": "boolean", "description": "Should this amount be debited to the customer.
    If true, the amount is taken into account when generating the debit file.
    If false, the amount is not taken into account when generating the debit file." }, "payable_to_shop": { "type": "boolean", "description": "Should this amount be paid to the shop.
    If true, the amount is taken into account when generating the shop payment voucher.
    If false, the amount is not taken into account when generating the shop payment voucher." } }, "required": [ "amount" ] }, "OR30_Response_200_Cancelations_Taxes_PurchaseTax": { "type": "object", "properties": { "purchase_amount": { "type": "number", "format": "with decimals", "description": "Purchase tax amount" }, "purchase_rate": { "type": "number", "format": "with decimals", "description": "Purchase tax rate" } }, "required": [ "purchase_amount" ] }, "OR31_Request": { "type": "object", "properties": { "order_additional_fields": { "type": "array", "description": "Order custom fields", "items": { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } }, "order_lines": { "type": "array", "description": "Order lines custom fields", "items": { "$ref": "#/components/schemas/OR31_Request_OrderLines" } } } }, "OR31_Request_OrderAdditionalFields": { "type": "object", "description": "Order line custom fields", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR31_Request_OrderAdditionalFields_Boolean", "DATE": "#/components/schemas/OR31_Request_OrderAdditionalFields_Date", "LINK": "#/components/schemas/OR31_Request_OrderAdditionalFields_Link", "LIST": "#/components/schemas/OR31_Request_OrderAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR31_Request_OrderAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR31_Request_OrderAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR31_Request_OrderAdditionalFields_Regex", "STRING": "#/components/schemas/OR31_Request_OrderAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR31_Request_OrderAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR31_Request_OrderAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines": { "type": "object", "description": "Order lines custom fields", "properties": { "order_line_additional_fields": { "type": "array", "description": "Order line custom fields", "items": { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } }, "order_line_id": { "type": "string", "description": "Order line identifier" } }, "required": [ "order_line_id" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields": { "type": "object", "description": "Order line custom fields", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_Boolean", "DATE": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_Date", "LINK": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_Link", "LIST": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_Regex", "STRING": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200": { "type": "object", "properties": { "order_update_errors": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors", "description": "Error report of an invalid request, with the body of the initial call" }, "order_update_result": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult", "description": "Order and order line custom fields values after the update has been processed" } } }, "OR31_Response_200_OrderUpdateErrors": { "type": "object", "properties": { "errors": { "type": "array", "description": "Errors about the input object", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Errors" }, "uniqueItems": true }, "input": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input", "description": "Invalid order custom fields values received" } }, "required": [ "errors" ] }, "OR31_Response_200_OrderUpdateErrors_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" } }, "required": [ "code", "field", "message" ] }, "OR31_Response_200_OrderUpdateErrors_Input": { "type": "object", "properties": { "order_additional_fields": { "type": "array", "description": "Order custom fields", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } }, "order_lines": { "type": "array", "description": "Order lines custom fields", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines" } } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Boolean", "DATE": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Date", "LINK": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Link", "LIST": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Regex", "STRING": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines": { "type": "object", "properties": { "order_line_additional_fields": { "type": "array", "description": "Order line custom fields", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } }, "order_line_id": { "type": "string", "description": "Order line identifier" } }, "required": [ "order_line_id" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Boolean", "DATE": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Date", "LINK": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Link", "LIST": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Regex", "STRING": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult": { "type": "object", "properties": { "order_additional_fields": { "type": "array", "description": "Custom fields of the order", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } }, "order_lines": { "type": "array", "description": "Order lines custom fields", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines" } } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Boolean", "DATE": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Date", "LINK": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Link", "LIST": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Regex", "STRING": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines": { "type": "object", "properties": { "order_line_additional_fields": { "type": "array", "description": "Order line custom fields", "items": { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } }, "order_line_id": { "type": "string", "description": "Order line identifier" } }, "required": [ "order_line_id" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields": { "type": "object", "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Boolean", "DATE": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Date", "LINK": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Link", "LIST": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Numeric", "REGEX": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Regex", "STRING": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_String", "TEXTAREA": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "OR32_Request": { "type": "object", "properties": { "order_lines": { "type": "array", "description": "Order lines to be updated, maximum number of order lines per call: 100", "items": { "$ref": "#/components/schemas/OR32_Request_OrderLines" }, "maxItems": 100, "minItems": 1 } }, "required": [ "order_lines" ] }, "OR32_Request_OrderLines": { "type": "object", "description": "Order lines to be updated, maximum number of order lines per call: 100", "properties": { "actual_measurement": { "type": "number", "format": "with decimals", "description": "Order line's actual measurement" }, "order_line_id": { "type": "string", "description": "Order Line identifier" } }, "required": [ "actual_measurement", "order_line_id" ] }, "OR32_Response_200": { "type": "object", "properties": { "order_lines_adjusted": { "type": "array", "description": "A list of updated order lines and orders in error objects", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted" } } } }, "OR32_Response_200_OrderLinesAdjusted": { "type": "object", "properties": { "cancelations": { "type": "array", "description": "List of representations of cancellations created by the adjustment", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Cancelations" } }, "errors": { "type": "array", "description": "List of errors encountered when updating order line", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Errors" } }, "measurement": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Measurement", "description": "Measurement information of the order line" }, "order_line_id": { "type": "string", "description": "Order line identifier" }, "refunds": { "type": "array", "description": "List of representations of refunds created by the adjustment", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Refunds" } } } }, "OR32_Response_200_OrderLinesAdjusted_Cancelations": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The offer part amount canceled" }, "currency_iso_code": { "type": "string", "description": "Enum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Cancelations_EcoContributions" } }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of goods canceled" }, "reason_code": { "type": "string", "description": "Cancellation's reason code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "The shipping charges part amount canceled" }, "shipping_taxes": { "type": "array", "description": "The taxes canceled on the shipping price", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Cancelations_ShippingTaxes" } }, "taxes": { "type": "array", "description": "The taxes canceled on the product price", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Cancelations_Taxes" } } } }, "OR32_Response_200_OrderLinesAdjusted_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR32_Response_200_OrderLinesAdjusted_Cancelations_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR32_Response_200_OrderLinesAdjusted_Cancelations_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR32_Response_200_OrderLinesAdjusted_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" } }, "required": [ "code", "field", "message" ] }, "OR32_Response_200_OrderLinesAdjusted_Measurement": { "type": "object", "properties": { "actual_measurement": { "type": "number", "format": "with decimals", "description": "Actual measurement on the order line" }, "adjustment_limit": { "type": "number", "format": "with decimals", "description": "Adjustment limit of the order line" }, "measurement_unit": { "type": "string", "description": "Measurement unit of the order line\n\nEnum: `\"GRAM\"`, `\"KILOGRAM\"`, `\"TON\"`, `\"POUND\"`, `\"OUNCE\"`, `\"MILLILITER\"`, `\"CENTILITER\"`, `\"CUBIC_METER\"`, `\"LITER\"`, `\"GALLON\"`, `\"FLUID_OUNCE\"`, `\"PINT\"`, `\"BARREL\"`, `\"CENTIMETER\"`, `\"METER\"`, `\"INCH\"`, `\"FEET\"`, `\"SQUARE_CENTIMETER\"`, `\"SQUARE_METER\"`, `\"SQUARE_INCH\"`, `\"SQUARE_FOOT\"`, `\"PIECE\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"USgal\"`, `\"bbl\"`, `\"cl\"`, `\"cm\"`, `\"cm2\"`, `\"floz\"`, `\"ft\"`, `\"ft2\"`, `\"g\"`, `\"in\"`, `\"in2\"`, `\"kg\"`, `\"l\"`, `\"lb\"`, `\"m\"`, `\"m2\"`, `\"m3\"`, `\"ml\"`, `\"oz\"`, `\"pt\"`, `\"t\"`\n
    \n" }, "ordered_measurement": { "type": "number", "format": "with decimals", "description": "Total measurement ordered on the order line" } } }, "OR32_Response_200_OrderLinesAdjusted_Refunds": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "The offer part amount refunded." }, "currency_iso_code": { "type": "string", "description": "Enum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "eco_contributions": { "type": "array", "description": "List of eco-contribution amounts and corresponding producer identifiers, if applicable
    \nOnly available if the operator activates the circular economy information collection.\n", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Refunds_EcoContributions" } }, "quantity": { "type": "integer", "format": "int32", "description": "The quantity of products refunded. This quantity is informative only." }, "reason_code": { "type": "string", "description": "Refund's reason code" }, "shipping_amount": { "type": "number", "format": "with decimals", "description": "The shipping charges part amount refunded" }, "shipping_taxes": { "type": "array", "description": "The taxes refunded on the shipping price", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Refunds_ShippingTaxes" } }, "taxes": { "type": "array", "description": "The taxes refunded on the product price", "items": { "$ref": "#/components/schemas/OR32_Response_200_OrderLinesAdjusted_Refunds_Taxes" } } } }, "OR32_Response_200_OrderLinesAdjusted_Refunds_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.
    Not present if the producer identifier belongs to the operator." }, "producer_id_owner": { "type": "string", "description": "Owner of the producerId" }, "total_amount": { "type": "number", "format": "with decimals", "description": "Total amount of the eco-contribution" }, "unit_amount": { "type": "number", "format": "with decimals", "description": "Unit amount of the eco-contribution" } }, "required": [ "epr_category_code", "producer_id", "producer_id_owner" ] }, "OR32_Response_200_OrderLinesAdjusted_Refunds_ShippingTaxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR32_Response_200_OrderLinesAdjusted_Refunds_Taxes": { "type": "object", "properties": { "amount": { "type": "number", "format": "with decimals", "description": "Tax amount" }, "code": { "type": "string", "description": "Tax code" } } }, "OR33_Request": { "type": "object", "properties": { "order_lines": { "type": "array", "description": "List of order line's representations, maximum number of order lines per call: 100", "items": { "$ref": "#/components/schemas/OR33_Request_OrderLines" }, "maxItems": 100, "minItems": 1 } }, "required": [ "order_lines" ] }, "OR33_Request_OrderLines": { "type": "object", "description": "List of order line's representations, maximum number of order lines per call: 100", "properties": { "id": { "type": "string", "description": "The identifier of the order line that must be fully canceled" }, "reason_code": { "type": "string", "description": "Cancelation reason code" } }, "required": [ "id", "reason_code" ] }, "OR41_Response_200": { "type": "object", "properties": { "messages": { "type": "array", "description": "List of messages", "items": { "$ref": "#/components/schemas/OR41_Response_200_Messages" } }, "total_count": { "type": "integer", "format": "int32", "description": "Total count of messages" } }, "required": [ "messages", "total_count" ] }, "OR41_Response_200_Messages": { "type": "object", "properties": { "archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "body": { "type": "string", "description": "Message body" }, "commercial_id": { "type": "string", "description": "Order commercial ID. Used only when retrieving messages of an order." }, "date_created": { "type": "string", "format": "date-time", "description": "Message creation date" }, "documents": { "type": "array", "description": "Documents list", "items": { "$ref": "#/components/schemas/OR41_Response_200_Messages_Documents" } }, "from_id": { "type": "string", "description": "Sender user identifier" }, "from_name": { "type": "string", "description": "Sender user name" }, "from_type": { "type": "string", "description": "Sender user type\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" }, "id": { "type": "integer", "format": "int64", "description": "Message identifier" }, "offer_id": { "type": "integer", "format": "int64", "description": "Identifier of offer : this value is not fixed and can changed after a long period" }, "order_id": { "type": "string", "description": "Order ID. Used only when retrieving messages of an order." }, "read": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "subject": { "type": "string", "description": "Message subject" }, "to_customer_archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "to_customer_id": { "type": "string", "description": "Recipient customer ID" }, "to_customer_name": { "type": "string", "description": "Recipient customer name" }, "to_operator": { "type": "boolean", "description": "Indicates the message sent to operator. Used only when retrieving messages of an order." }, "to_operator_archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "to_shop_archived": { "type": "boolean", "deprecated": true, "description": "Will be removed in next version" }, "to_shop_id": { "type": "integer", "format": "int64", "description": "Recipient shop ID" }, "to_shop_name": { "type": "string", "description": "Recipient shop name" }, "visible": { "type": "boolean", "deprecated": true, "description": "States whether or not the message is visible (public). Only relevant for messages on offers and always null for messages on orders." } }, "required": [ "body", "commercial_id", "date_created", "from_id", "from_name", "from_type", "id", "subject", "to_customer_archived", "to_customer_id", "to_customer_name", "to_operator", "to_operator_archived", "to_shop_archived", "to_shop_id", "to_shop_name" ] }, "OR41_Response_200_Messages_Documents": { "type": "object", "properties": { "date_uploaded": { "type": "string", "format": "date-time", "description": "Document uploaded date" }, "file_name": { "type": "string", "description": "Document file name" }, "file_size": { "type": "integer", "format": "int64", "description": "File size" }, "id": { "type": "integer", "format": "int64", "description": "Document identifier" }, "type": { "type": "string", "description": "Document type code" } }, "required": [ "file_name", "id", "type" ] }, "OR42_Request": { "type": "object", "properties": { "body": { "type": "string", "description": "Body of the message", "maxLength": 50000, "minLength": 3 }, "document_ids": { "type": "array", "description": "Message's attachments. List of document ids already linked to the order. Use OR74 to upload new documents and OR72 to retrieve their ids. NB: If one of those document_id have already been linked to a previous message, it will be ignored.", "items": { "type": "integer", "format": "int64" } }, "subject": { "type": "string", "description": "Subject of the message", "maxLength": 200, "minLength": 3 }, "to_customer": { "type": "boolean", "description": "Boolean to indicate the message will be sent to the customer associated with the order." }, "to_operator": { "type": "boolean", "description": "Boolean to indicate the message will be sent to the operator." }, "to_shop": { "type": "boolean", "description": "Boolean to indicate the message will be sent to the shop associated with the order" } }, "required": [ "body", "subject", "to_customer", "to_operator", "to_shop" ] }, "OR42_Response_201": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Identifier of the message created" } }, "required": [ "id" ] }, "OR43_Request_MultipartFormData_ThreadInput": { "type": "object", "properties": { "body": { "type": "string", "description": "Message body", "maxLength": 50000, "minLength": 3 }, "to": { "type": "array", "description": "Message recipients", "items": { "type": "string", "description": "Enum: `\"OPERATOR\"`, `\"SHOP\"`, `\"CUSTOMER\"`\n" } }, "topic": { "$ref": "#/components/schemas/OR43_Request_MultipartFormData_ThreadInput_Topic", "description": "Thread topic

    The topic can either have a free or a fixed value depending on the topic type" } }, "required": [ "body", "to", "topic" ] }, "OR43_Request_MultipartFormData_ThreadInput_Topic": { "type": "object", "description": "Thread topic

    The topic can either have a free or a fixed value depending on the topic type", "discriminator": { "mapping": { "FREE_TEXT": "#/components/schemas/OR43_Request_MultipartFormData_ThreadInput_Topic_FreeText", "REASON_CODE": "#/components/schemas/OR43_Request_MultipartFormData_ThreadInput_Topic_ReasonCode" }, "propertyName": "type" }, "properties": { "type": { "type": "string", "description": "Topic type\n\nEnum: `\"FREE_TEXT\"`, `\"REASON_CODE\"`\n" }, "value": { "type": "string", "description": "Topic value" } }, "required": [ "type", "value" ] }, "OR43_Request_MultipartFormData_ThreadInput_Topic_FreeText": { "type": "object", "properties": { "type": { "type": "string", "description": "Must be FREE_TEXT" }, "value": { "type": "string", "description": "Topic value", "maxLength": 200, "minLength": 3 } }, "required": [ "type", "value" ] }, "OR43_Request_MultipartFormData_ThreadInput_Topic_ReasonCode": { "type": "object", "properties": { "type": { "type": "string", "description": "Must be REASON_CODE" }, "value": { "type": "string", "description": "Code of the reason", "maxLength": 200, "minLength": 1 } }, "required": [ "type", "value" ] }, "OR43_Response_201": { "type": "object", "properties": { "message_id": { "type": "string", "description": "Id of the first message created on the thread" }, "thread_id": { "type": "string", "description": "Id of the created thread" } }, "required": [ "message_id", "thread_id" ] }, "OR51_Response_200": { "type": "object", "properties": { "assessments": { "type": "array", "description": "List of assessments", "items": { "$ref": "#/components/schemas/OR51_Response_200_Assessments" } }, "comment": { "type": "string", "description": "Evaluation comment" }, "customer_id": { "type": "string", "description": "Identifier of the customer who posted the evaluation" }, "date": { "type": "string", "format": "date-time", "description": "Evaluation creation date" }, "firstname": { "type": "string", "description": "First name of the customer who posted the evaluation" }, "grade": { "type": "integer", "format": "int32", "description": "Evaluation grade" }, "last_updated_date": { "type": "string", "format": "date-time", "description": "Evaluation last updated date" }, "lastname": { "type": "string", "description": "Last name of the customer who posted the evaluation" }, "reply": { "$ref": "#/components/schemas/OR51_Response_200_Reply", "description": "Reply of a shop or operator on an evaluation" }, "visible": { "type": "boolean", "description": "Whether the evaluation is visible or not" } }, "required": [ "assessments", "customer_id", "date", "firstname", "grade", "last_updated_date", "lastname", "visible" ] }, "OR51_Response_200_Assessments": { "type": "object", "properties": { "code": { "type": "string", "description": "Assessment code" }, "label": { "type": "string", "description": "Assessment label " }, "response": { "type": "string", "description": "Response associated with the assessment" } }, "required": [ "code", "label", "response" ] }, "OR51_Response_200_Reply": { "type": "object", "properties": { "comment": { "type": "string", "description": "Text of the reply", "maxLength": 1000, "minLength": 1 }, "date": { "type": "string", "format": "date-time", "description": "Reply date" }, "type": { "type": "string", "description": "Type of user who replied\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`\n" } }, "required": [ "comment", "date", "type" ] }, "OR64_Request": { "type": "object", "properties": { "reason_code": { "type": "string", "description": "Incident resolution reason code" } }, "required": [ "reason_code" ] }, "OR72_Response_200": { "type": "object", "properties": { "order_documents": { "type": "array", "description": "The document details", "items": { "$ref": "#/components/schemas/OR72_Response_200_OrderDocuments" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total number of documents" } }, "required": [ "order_documents" ] }, "OR72_Response_200_OrderDocuments": { "type": "object", "properties": { "date_uploaded": { "type": "string", "format": "date-time", "description": "Document uploaded date" }, "file_name": { "type": "string", "description": "Document file name" }, "file_size": { "type": "integer", "format": "int64", "description": "Document file size" }, "id": { "type": "integer", "format": "int64", "description": "Document identifier" }, "order_id": { "type": "string", "description": "The id of the order owning the document" }, "type": { "type": "string", "description": "Document type code" } }, "required": [ "file_name", "id", "order_id", "type" ] }, "OR74_Request_MultipartFormData_OrderDocuments": { "type": "object", "properties": { "order_documents": { "type": "array", "items": { "$ref": "#/components/schemas/OR74_Request_MultipartFormData_OrderDocuments_OrderDocuments" } } }, "required": [ "order_documents" ] }, "OR74_Request_MultipartFormData_OrderDocuments_OrderDocuments": { "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/OR74_Request_MultipartFormData_OrderDocuments_OrderDocuments_Entity", "description": "Document entity. Should only be used with the return feature and not for any other kind of documents." }, "file_name": { "type": "string", "description": "File name" }, "type_code": { "type": "string", "description": "Document type code" } }, "required": [ "file_name", "type_code" ] }, "OR74_Request_MultipartFormData_OrderDocuments_OrderDocuments_Entity": { "type": "object", "description": "Document entity. Should only be used with the return feature and not for any other kind of documents.", "properties": { "id": { "type": "string", "description": "Document entity ID" }, "type": { "type": "string", "description": "Document entity\n\nEnum: `\"RETURN\"`\n" } }, "required": [ "id", "type" ] }, "OR74_Response_200": { "type": "object", "properties": { "errors_count": { "type": "integer", "format": "int32", "description": "The number of documents in an error state" }, "order_documents": { "type": "array", "description": "Lists of error reports associated to each document in an error state", "items": { "$ref": "#/components/schemas/OR74_Response_200_OrderDocuments" } } }, "required": [ "order_documents" ] }, "OR74_Response_200_OrderDocuments": { "type": "object", "properties": { "errors": { "type": "array", "description": "Errors about the input object", "items": { "$ref": "#/components/schemas/OR74_Response_200_OrderDocuments_Errors" }, "uniqueItems": true }, "input": { "$ref": "#/components/schemas/OR74_Response_200_OrderDocuments_Input", "description": "Invalid order document that was received from caller." } }, "required": [ "errors" ] }, "OR74_Response_200_OrderDocuments_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" } }, "required": [ "code", "field", "message" ] }, "OR74_Response_200_OrderDocuments_Input": { "type": "object", "properties": { "file_name": { "type": "string" }, "type_code": { "type": "string" } } }, "OR75_Response_200": { "type": "object", "properties": { "taxes": { "type": "array", "description": "List of the order taxes", "items": { "$ref": "#/components/schemas/OR75_Response_200_Taxes" } } }, "required": [ "taxes" ] }, "OR75_Response_200_Taxes": { "type": "object", "properties": { "code": { "type": "string", "description": "Tax code" }, "label": { "type": "string", "description": "Tax label " }, "tax_calculation_rule": { "type": "string", "description": "The type of automated calculation done during a partial refund or cancellation.
    Possible values:
    - none: No calculation will be done in case of partial refund or cancellation. You must provide the amount of tax you want to refund or cancel when you request a refund or cancellation. Otherwise, the tax will not get refunded/cancelled.
    - proportional_to_amount: Mirakl will automatically calculate the proportional tax amount when a refund or cancellation is requested. You do not need to provide the amount of this tax when you request a refund or cancellation.\n\nEnum: `\"PROPORTIONAL_TO_AMOUNT\"`, `\"NONE\"`\n" } }, "required": [ "code", "label", "tax_calculation_rule" ] }, "P11_Response_200": { "type": "object", "properties": { "products": { "type": "array", "description": "List of products information with their offers", "items": { "$ref": "#/components/schemas/P11_Response_200_Products" } } } }, "P11_Response_200_Products": { "type": "object", "properties": { "category_code": { "type": "string", "description": "Code of the product category" }, "category_label": { "type": "string", "description": "Label of the product category " }, "measurement": { "$ref": "#/components/schemas/P11_Response_200_Products_Measurement", "description": "Measurement of the product" }, "offers": { "type": "array", "description": "List of offers for the product", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers" } }, "product_brand": { "type": "string", "description": "Brand of the product" }, "product_description": { "type": "string", "description": "Description of the product" }, "product_media": { "$ref": "#/components/schemas/P11_Response_200_Products_ProductMedia", "description": "Media of the product" }, "product_references": { "type": "array", "description": "List of product's references", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_ProductReferences" } }, "product_sku": { "type": "string", "description": "SKU of the product" }, "product_title": { "type": "string", "description": "Title of the product" }, "total_count": { "type": "integer", "format": "int32", "description": "Number of offers for this product" } }, "required": [ "category_code", "category_label", "product_references", "product_sku", "product_title", "total_count" ] }, "P11_Response_200_Products_Measurement": { "type": "object", "properties": { "total_measurement_of_product": { "type": "number", "format": "with decimals", "description": "Product total measurement" }, "unit": { "type": "string", "description": "Product measurement unit" } }, "required": [ "unit" ] }, "P11_Response_200_Products_Offers": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Is the offer active" }, "all_prices": { "type": "array", "description": "All prices for the offer\n
    \nFor Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices\n", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_AllPrices" } }, "allow_quote_requests": { "type": "boolean", "description": "Whether the offer is eligible for quotation" }, "applicable_pricing": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_ApplicablePricing", "description": "Pricing defined for the offer, including the prices for the selected channel if available\n
    \nFor Dropship specifically: the list of applicable purchasing prices of the offer, also referred to as costs or wholesale prices.\n" }, "available_end_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "

    Available end date

    value is always null

    " }, "available_start_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "

    Available start date

    value is always null

    " }, "channels": { "type": "array", "deprecated": true, "description": "

    List of channel codes on which the offer can be sold

    value is always []

    ", "items": { "type": "string", "deprecated": true }, "uniqueItems": true }, "currency_iso_code": { "type": "string", "description": "The currency of the shop (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "description": { "type": "string", "description": "Offer description" }, "discount": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_Discount", "deprecated": true, "description": "

    Discount of the offer

    value is always null

    " }, "eco_contributions": { "type": "array", "description": "Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_EcoContributions" }, "maxItems": 20 }, "favorite_rank": { "type": "integer", "format": "int32", "deprecated": true, "description": "

    Favorite rank if the offer is favorite and if the favorite offer feature is enabled

    value is always null

    " }, "inactivity_reasons": { "type": "array", "description": "Reasons for offers inactivity, mandatory if an offer is inactive", "items": { "type": "string", "description": "Enum: `\"PRODUCT_STATUS_NEW\"`, `\"PRODUCT_STATUS_INVALID\"`, `\"PRODUCT_STATUS_REJECTED\"`, `\"PRODUCT_STATUS_UNAUTHORIZED_TO_SELL\"`, `\"PRODUCT_STATUS_PENDING\"`, `\"PRODUCT_STATUS_SYNCHRO_ERROR\"`, `\"PRODUCT_DISABLED\"`, `\"SHOP_NOT_OPEN\"`, `\"ZERO_QUANTITY\"`, `\"NO_MIN_SHIPPING_RATE\"`, `\"NOT_IN_AVAILABILITY_PERIOD\"`, `\"NO_CHANNEL_ON_SHOP\"`, `\"SHOP_CURRENCY_DISABLED\"`, `\"AVAILABLE_QUANTITY_LESS_THAN_MIN_ORDER_QUANTITY\"`, `\"AVAILABLE_QUANTITY_LESS_THAN_PACKAGE_QUANTITY\"`, `\"NO_ACTIVE_PRICE\"`, `\"CATEGORY_UNAUTHORIZED_TO_SELL\"`, `\"BRAND_UNAUTHORIZED_TO_SELL\"`, `\"OFFER_STATE_UNAUTHORIZED_TO_SELL\"`\n" } }, "is_professional": { "type": "boolean", "description": "Whether or not the shop is professional" }, "leadtime_to_ship": { "type": "integer", "format": "int32", "description": "Offer's lead time to ship value. If this value has been set to 0, value is returned as 1 (unless platform's default lead time to ship value is also 0). If no lead time to ship was specified for the offer, platform's default value is returned." }, "logistic_class": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_LogisticClass", "deprecated": true, "description": "

    The logistic class associated to the offer

    value is always null

    " }, "min_quantity_alert": { "type": "integer", "format": "int32", "deprecated": true, "description": "

    Mininum quantity of the offer

    value is always null

    " }, "min_shipping_price": { "type": "number", "format": "with decimals", "description": "Unit price of the minimum shipping rate" }, "min_shipping_price_additional": { "type": "number", "format": "with decimals", "description": "Additional unit price associated to the minimum shipping rate" }, "min_shipping_type": { "type": "string", "description": "Code of the shipping type associated to the minimum shipping rate" }, "min_shipping_zone": { "type": "string", "description": "Code of the shipping zone associated to the minimum shipping rate" }, "msrp": { "type": "number", "format": "with decimals", "description": "The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).\n
    \nApplicable only for Dropship offers.\n" }, "nb_evaluation": { "type": "integer", "format": "int64", "description": "Number of customers evaluations" }, "offer_additional_fields": { "type": "array", "deprecated": true, "description": "

    List of custom fields

    value is always []

    ", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } }, "offer_id": { "type": "integer", "format": "int64", "deprecated": true, "description": "

    Identifier of the offer

    value is always 0

    " }, "premium": { "type": "boolean", "deprecated": true, "description": "

    Shop is premium

    value is always false

    " }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer\n
    \nFor Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price\n" }, "price_additional_info": { "type": "string", "description": "Additional price information for the offer" }, "quantity": { "type": "integer", "format": "int32", "deprecated": true, "description": "

    Available quantity of the offer

    value is always 999

    " }, "retail_prices": { "type": "array", "description": "List retail prices for the offer, also referred to as selling prices.\n
    \nApplicable only for Dropship offers.\n", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_RetailPrices" } }, "shipping_deadline": { "type": "string", "format": "date-time", "description": "Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers" }, "shipping_types": { "type": "array", "description": "List of shipping types compatible with the given offer", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_ShippingTypes" } }, "shop_grade": { "type": "number", "format": "with decimals", "description": "Grade of the shop which proposes the offer" }, "shop_id": { "type": "integer", "format": "int64", "deprecated": true, "description": "

    Shop offer ID

    value is always null

    " }, "shop_name": { "type": "string", "description": "Name of the shop which proposes the offer" }, "state_code": { "type": "string", "description": "Offer condition" }, "total_price": { "type": "number", "format": "with decimals", "description": "Total price of the offer (price + minimum shipping rate)\n
    \nFor Dropship specifically: the purchasing price of the offer + minimum shipping rate\n" } }, "required": [ "active", "all_prices", "channels", "currency_iso_code", "description", "is_professional", "leadtime_to_ship", "logistic_class", "min_quantity_alert", "min_shipping_price", "min_shipping_price_additional", "min_shipping_type", "min_shipping_zone", "nb_evaluation", "offer_id", "premium", "quantity", "shipping_deadline", "shop_grade", "shop_id", "shop_name", "state_code" ] }, "P11_Response_200_Products_Offers_AllPrices": { "type": "object", "properties": { "channel_code": { "type": "string", "deprecated": true, "description": " Single Channel Pricing users: The channel code on which a specific price applies.\n This is the pricing_channel_code supplied as input in the API if prices are defined for this channel.\n If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices.\n channel_code is set to null for the default prices. Multi Channel Pricing users: returned null.\n Refer to context > channel_codes in order to retrieve the channel codes for which the price apply.\n" }, "context": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_AllPrices_Context", "description": "The context is not returned for default prices.\n" }, "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer.\n
    \nFor Dropship specifically: the purchasing price of the offer\n
    \nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
    \nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount price for a quantity of one, i.e. the discount price for a quantity of one.\n
    \nFor Dropship specifically: the discount purchasing price for a quantity of one\n
    \nSet to null if no discount is defined or if no discount price for a quantity of one is defined.\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts.\n
    \nFor Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.\n", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_AllPrices_VolumePrices" } } }, "required": [ "price", "unit_origin_price", "volume_prices" ] }, "P11_Response_200_Products_Offers_AllPrices_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.", "items": { "type": "string" } }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price." } } }, "P11_Response_200_Products_Offers_AllPrices_VolumePrices": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price." }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity threshold of this price range" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } }, "required": [ "price", "quantity_threshold", "unit_discount_price", "unit_origin_price" ] }, "P11_Response_200_Products_Offers_ApplicablePricing": { "type": "object", "properties": { "channel_code": { "type": "string", "deprecated": true, "description": " Single Channel Pricing users: The channel code on which a specific price applies.\n This is the pricing_channel_code supplied as input in the API if prices are defined for this channel.\n If no pricing is defined for this channel, or no pricing_channel_code is supplied, it falls back on the default prices.\n channel_code is set to null for the default prices. Multi Channel Pricing users: returned null.\n Refer to context > channel_codes in order to retrieve the channel codes for which the price apply.\n" }, "context": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_ApplicablePricing_Context", "description": "The context is not returned for default prices.\n" }, "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Price of the offer.\n
    \nFor Dropship specifically: the purchasing price of the offer\n
    \nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
    \nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount price for a quantity of one, i.e. the discount price for a quantity of one.\n
    \nFor Dropship specifically: the discount purchasing price for a quantity of one\n
    \nSet to null if no discount is defined or if no discount price for a quantity of one is defined.\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original price for a quantity of one, i.e. the price for a quantity of one regardless of the discounts.\n
    \nFor Dropship specifically: the purchasing price for a quantity of one, also referred to as cost or wholesale price\n" }, "volume_prices": { "type": "array", "description": "Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.\n", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_ApplicablePricing_VolumePrices" } } }, "required": [ "price", "unit_origin_price", "volume_prices" ] }, "P11_Response_200_Products_Offers_ApplicablePricing_Context": { "type": "object", "properties": { "channel_codes": { "type": "array", "description": "The channel codes on which a specific price applies.", "items": { "type": "string" } }, "customer_group_ids": { "type": "array", "description": "The customer group ids on which a specific price applies.", "items": { "type": "string" } }, "customer_organization_ids": { "type": "array", "description": "The customer organization ids on which a specific price applies.", "items": { "type": "string" } }, "end_date": { "type": "string", "format": "date-time", "description": "The end date of a specific price." }, "start_date": { "type": "string", "format": "date-time", "description": "The start date of a specific price." } } }, "P11_Response_200_Products_Offers_ApplicablePricing_VolumePrices": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer. If the discount is currently active, it represents the unit discount price. Otherwise it is the original price." }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Quantity threshold of this price range" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Unit discount price for this quantity threshold" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Unit price for this quantity threshold" } }, "required": [ "price", "quantity_threshold", "unit_discount_price", "unit_origin_price" ] }, "P11_Response_200_Products_Offers_Discount": { "type": "object", "deprecated": true, "properties": { "discount_price": { "type": "number", "format": "with decimals", "description": "Discount price. Not to be read if discount with ranges is specified (i.e. discount with at least one range with quantity threshold greater than one).
    For Dropship specifically: the purchasing discount price." }, "end_date": { "type": "string", "format": "date-time", "description": "Discount end date" }, "origin_price": { "type": "number", "format": "with decimals", "description": "Origin price
    For Dropship specifically: the origin purchasing price" }, "ranges": { "type": "array", "description": "Discount ranges", "items": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_Discount_Ranges" } }, "start_date": { "type": "string", "format": "date-time", "description": "Discount start date" } } }, "P11_Response_200_Products_Offers_Discount_Ranges": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "Price of the offer if the quantity threshold is reached" }, "quantity_threshold": { "type": "integer", "format": "int32", "description": "Minimum quantity to order for the given price to be applied" } }, "required": [ "price", "quantity_threshold" ] }, "P11_Response_200_Products_Offers_EcoContributions": { "type": "object", "properties": { "eco_contribution_amount": { "type": "number", "format": "with decimals", "description": "Amount of the eco-contribution." }, "epr_category_code": { "type": "string", "description": "Extended Producer Responsibility (EPR) category code.\n\nEnum: `\"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\"`\n", "maxLength": 255, "minLength": 0 }, "producer_id": { "type": "string", "description": "Producer identifier of the eco-contribution.
    Not present if the producer identifier belongs to the operator.", "maxLength": 255, "minLength": 0 } }, "required": [ "epr_category_code" ] }, "P11_Response_200_Products_Offers_LogisticClass": { "type": "object", "deprecated": true, "properties": { "code": { "type": "string", "description": "Logistic class code" }, "label": { "type": "string", "description": "Logistic class label " } }, "required": [ "code", "label" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields": { "type": "object", "deprecated": true, "discriminator": { "mapping": { "BOOLEAN": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_Boolean", "DATE": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_Date", "LINK": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_Link", "LIST": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_List", "MULTIPLE_VALUES_LIST": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_MultipleValuesList", "NUMERIC": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_Numeric", "REGEX": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_Regex", "STRING": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_String", "TEXTAREA": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields_Textarea" }, "propertyName": "type" }, "properties": { "code": { "type": "string", "description": "Custom field's code" }, "type": { "type": "string", "description": "Custom field's type\n\nEnum: `\"STRING\"`, `\"DATE\"`, `\"NUMERIC\"`, `\"BOOLEAN\"`, `\"LINK\"`, `\"REGEX\"`, `\"TEXTAREA\"`, `\"LIST\"`, `\"MULTIPLE_VALUES_LIST\"`\n" } }, "required": [ "code" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Boolean": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "condition", "type": "BOOLEAN", "value": "true" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "date-field", "type": "DATE", "value": "2013-10-21T13:28:06.419Z" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Link": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "link-somewhere", "type": "LINK", "value": "https://example.com" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_List": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "colors", "type": "LIST", "value": "red" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_MultipleValuesList": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "color", "type": "MULTIPLE_VALUES_LIST", "value": [ "RED", "GREEN" ] }, "properties": { "value": { "type": "array", "description": "Values of the custom field", "items": { "type": "string" } } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Numeric": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "number", "type": "NUMERIC", "value": "1337" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Regex": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "regex-condition", "type": "REGEX", "value": "johndoe\\.[a-z]{2,3}" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_String": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "accounting-number", "type": "STRING", "value": "0425367896" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Textarea": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "example": { "code": "additional-description", "type": "TEXTAREA", "value": "description" }, "properties": { "value": { "type": "string", "description": "Custom field's value" } }, "required": [ "value" ] }, "P11_Response_200_Products_Offers_RetailPrices": { "type": "object", "properties": { "discount_end_date": { "type": "string", "format": "date-time", "description": "End date of the discount, or null if no discount exists or if the discount does not have an end date." }, "discount_start_date": { "type": "string", "format": "date-time", "description": "Start date of the discount, or null if no discount exists or if the discount does not have a start date." }, "price": { "type": "number", "format": "with decimals", "description": "Retail price of the offer, also referred to as selling price.\n
    \nIf a discount is defined and is currently active (within the validity interval), it represents the unit_discount_price.\n
    \nIn other cases, it represents the unit_origin_price.\n" }, "unit_discount_price": { "type": "number", "format": "with decimals", "description": "Discount retail price for a quantity of one, i.e. the discount retail price for a quantity of one.\n
    \nSet to null if no discount is defined or if no discount retail price for a quantity of one is defined or if the discount is not currently active (within the validity interval).\n" }, "unit_origin_price": { "type": "number", "format": "with decimals", "description": "Original retail price for a quantity of one, i.e. the retail price for a quantity of one regardless of the discounts." } }, "required": [ "price", "unit_origin_price" ] }, "P11_Response_200_Products_Offers_ShippingTypes": { "type": "object", "properties": { "code": { "type": "string", "description": "Shipping type code" }, "cut_off_next_date": { "type": "string", "format": "date-time", "description": "Next cutoff date" }, "cut_off_time": { "type": "string", "format": "time", "description": "Shipping type Cutoff time" }, "delivery_time": { "$ref": "#/components/schemas/P11_Response_200_Products_Offers_ShippingTypes_DeliveryTime", "description": "Expected delivery time" }, "label": { "type": "string", "description": "Shipping type label" }, "shipping_deadline": { "type": "string", "format": "date-time", "description": "Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers" }, "shipping_price_type": { "type": "string", "description": "Shipping price type of the offer for a given zone method\n\nEnum: `\"FIXED_PRICE\"`, `\"FREE_SHIPPING\"`, `\"ORDER_PRICE_RANGE\"`\n" }, "shipping_price_unit": { "type": "number", "format": "with decimals", "description": "Shipping price of the offer" }, "shipping_zone_code": { "type": "string", "description": "Shipping zone code" }, "shipping_zone_label": { "type": "string", "description": "Shipping zone label" }, "standard_code": { "type": "string", "description": "Shipping type standard code" } }, "required": [ "code", "label", "shipping_price_type", "shipping_price_unit", "shipping_zone_code", "shipping_zone_label" ] }, "P11_Response_200_Products_Offers_ShippingTypes_DeliveryTime": { "type": "object", "properties": { "earliest_days": { "type": "integer", "format": "int32", "description": "Earliest order delivery time" }, "earliest_delivery_date": { "type": "string", "format": "date-time", "description": "Earliest order delivery date" }, "latest_days": { "type": "integer", "format": "int32", "description": "Latest order delivery time" }, "latest_delivery_date": { "type": "string", "format": "date-time", "description": "Latest order delivery date" } }, "required": [ "earliest_days", "earliest_delivery_date", "latest_days", "latest_delivery_date" ] }, "P11_Response_200_Products_ProductMedia": { "type": "object", "properties": { "dam_url": { "type": "string", "description": "DAM URL for the media provided when available, otherwise use media_url" }, "media_url": { "type": "string", "description": "Media URL" }, "type": { "type": "string", "description": "Media TYPE (small, large...)" } }, "required": [ "dam_url", "media_url", "type" ] }, "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" } }, "required": [ "reference", "reference_type" ] }, "P31_Response_200": { "type": "object", "properties": { "products": { "type": "array", "description": "Products list", "items": { "$ref": "#/components/schemas/P31_Response_200_Products" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count" } }, "required": [ "products", "total_count" ] }, "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" } }, "required": [ "category_code", "category_label", "product_id", "product_id_type", "product_sku", "product_title" ] }, "P41_Request_MultipartFormData_ConversionOptions": { "type": "object", "properties": { "ai_enrichment": { "$ref": "#/components/schemas/P41_Request_MultipartFormData_ConversionOptions_AiEnrichment", "description": "Enable AI enrichment. Default to DISABLED" }, "ai_rewrite": { "$ref": "#/components/schemas/P41_Request_MultipartFormData_ConversionOptions_AiRewrite", "description": "Enable AI rewrite. Default to ENABLED" }, "ai_translation": { "$ref": "#/components/schemas/P41_Request_MultipartFormData_ConversionOptions_AiTranslation", "description": "Enable AI translation. Default to DISABLED" } } }, "P41_Request_MultipartFormData_ConversionOptions_AiEnrichment": { "type": "object", "description": "Enable AI translation. Default to DISABLED", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P41_Request_MultipartFormData_ConversionOptions_AiRewrite": { "type": "object", "description": "Enable AI translation. Default to DISABLED", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P41_Request_MultipartFormData_ConversionOptions_AiTranslation": { "type": "object", "description": "Enable AI translation. Default to DISABLED", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P41_Response_201": { "type": "object", "properties": { "import_id": { "type": "integer", "format": "int64", "description": "Import identifier" } }, "required": [ "import_id" ] }, "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\n\nEnum: `\"AI_CONVERTER\"`\n" }, "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\n\nEnum: `\"TRANSFORMATION_WAITING\"`, `\"TRANSFORMATION_RUNNING\"`, `\"TRANSFORMATION_FAILED\"`, `\"WAITING\"`, `\"RUNNING\"`, `\"SENT\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n" }, "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" } }, "required": [ "date_created", "has_error_report", "has_new_product_report", "has_transformed_file", "import_id", "import_status", "shop_id", "transform_lines_in_error", "transform_lines_in_success", "transform_lines_read", "transform_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", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P42_Response_200_ConversionOptions_AiRewrite": { "type": "object", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P42_Response_200_ConversionOptions_AiTranslation": { "type": "object", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "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" } }, "required": [ "total_count" ] }, "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\n\nEnum: `\"AI_CONVERTER\"`\n" }, "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\n\nEnum: `\"TRANSFORMATION_WAITING\"`, `\"TRANSFORMATION_RUNNING\"`, `\"TRANSFORMATION_FAILED\"`, `\"WAITING\"`, `\"RUNNING\"`, `\"SENT\"`, `\"COMPLETE\"`, `\"CANCELLED\"`, `\"FAILED\"`\n" }, "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" } }, "required": [ "date_created", "has_error_report", "has_new_product_report", "has_transformed_file", "import_id", "import_status", "shop_id", "transform_lines_in_error", "transform_lines_in_success", "transform_lines_read", "transform_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", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite": { "type": "object", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation": { "type": "object", "properties": { "status": { "type": "string", "description": "Enum: `\"ENABLED\"`, `\"DISABLED\"`\n" } } }, "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" } }, "required": [ "features", "modules", "platform_configuration", "platform_name", "tenant_name", "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\n\nEnum: `\"YES\"`, `\"NO\"`, `\"YES_PER_STORE\"`\n" }, "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.\n\nEnum: `\"COMMA\"`, `\"SEMICOLON\"`\n" }, "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.\n\nEnum: `\"TAX_INCLUDED\"`, `\"TAX_EXCLUDED\"`\n" }, "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

    Moved in catalog section. Use catalog.product_data_validation_by_channel instead.

    " }, "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" } }, "required": [ "catalog", "circular_economy_data_collection", "competitive_pricing_tool", "direct_payment_customer_store", "disable_seller_alternative_carrier", "dropship", "kyc_status_per_seller", "lead_time_to_ship_by_sellers_enabled", "multi_currency", "multi_payout_psp_per_seller", "no_reply_needed", "offer_prices_decimals", "operator_csv_delimiter", "order_conditions", "order_tax_mode", "order_workflows", "payment_confirmation", "pricing", "product_data_validation_by_channel", "promotion", "returns", "shipment", "shop_tax_options", "tax_collection", "tax_id_number", "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" } }, "required": [ "allow_shop_contribution_to_all_channels", "exclude_invalid_products", "list_of_multiple_values_separator", "product_acceptance_by_channel", "product_data_validation_by_channel", "product_import_only_on_leaf" ] }, "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" } }, "required": [ "activated", "refund_cancel_authorized" ] }, "PC01_Response_200_Features_Dropship": { "type": "object", "properties": { "retail_pricing_edition_enabled": { "type": "string", "description": "Retail pricing edition enabled\n\nEnum: `\"YES\"`, `\"NO\"`, `\"YES_PER_STORE\"`\n" }, "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

    Use \"lead_time_to_ship_by_sellers_enabled\" attribute instead.

    " }, "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" } }, "required": [ "lead_time_to_ship", "maximum_order_quantity", "minimum_order_quantity", "package_order_quantity" ] }, "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\n\nEnum: `\"AUTOMATIC\"`, `\"NOT_AUTOMATIC\"`, `\"BOTH\"`\n" }, "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" } }, "required": [ "no_customer_payment_confirmation", "order_acceptance", "pause_debit_workflow", "pay_on_due_date", "pay_on_shipment", "sellers_edit_shipping_origin", "shipping_and_billing_details_before_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.\n\nEnum: `\"MULTI\"`, `\"SINGLE\"`, `\"DISABLED\"`\n" }, "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" } }, "required": [ "channel_pricing", "discount_period_required", "discount_price_creation_in_the_past_blocked", "scheduled_pricing", "volume_discount", "volume_pricing" ] }, "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." } }, "required": [ "cart_promotion_campaign", "discount_campaign", "seller_promotion" ] }, "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" } }, "required": [ "multi_part_item_shipment", "multi_shipment" ] }, "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" } }, "required": [ "tax_identification_number" ] }, "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" } }, "required": [ "mandatory" ] }, "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" } }, "required": [ "mandatory" ] }, "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.\n\nEnum: `\"YES\"`, `\"NO\"`, `\"YES_PER_STORE\"`\n" }, "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" } }, "required": [ "activated", "product_tax_code_mandatory", "tax_collection_by_operator" ] }, "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" } }, "required": [ "mandatory" ] }, "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", "description": "Enum: `\"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\"`\n" } } }, "required": [ "geolocation", "restricted_countries" ] }, "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

    The tax_manager feature is not supported anymore.

    " } }, "required": [ "mirakl_catalog_integrator", "mirakl_catalog_manager", "mirakl_catalog_transformer", "mirakl_platform_services", "offer_management", "order_management", "promotions", "quotes", "tax_manager" ] }, "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" } }, "required": [ "activated", "tax_provider" ] }, "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" } }, "required": [ "avalara", "vertex" ] }, "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 " } }, "required": [ "customer_model", "enhanced_seller_invoicing", "platform_model" ] }, "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" } }, "required": [ "b2b", "b2c" ] }, "PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enhanced seller invoicing activated." } }, "required": [ "enabled" ] }, "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" } }, "required": [ "drop_ship", "marketplace", "one_creditor" ] }, "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." } }, "required": [ "data" ] }, "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\n\nEnum: `\"NOTHING_TO_PREPARE\"`, `\"WAITING_PREPARATION\"`, `\"IN_PREPARATION\"`, `\"READY_FOR_PICKUP\"`, `\"CLOSED\"`\n" } }, "required": [ "date_created", "id", "last_updated", "order_lines", "picklist_lines", "pickup_date", "state" ] }, "PL11_Response_200_Data_OrderLines": { "type": "object", "properties": { "id": { "type": "string", "description": "Picklist order line id" } }, "required": [ "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" } }, "required": [ "offer_id", "quantity" ] }, "PM11_Response_200": { "type": "object", "description": "JSON output", "properties": { "attributes": { "type": "array", "description": "List of attributes", "items": { "$ref": "#/components/schemas/PM11_Response_200_Attributes" } } }, "required": [ "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

    Use the \"type_parameters\" field for \"LIST\" attribute types to retrieve the default value.

    " }, "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

    This field is deprecated. Use the \"requirement_level\" field instead.

    " }, "requirement_level": { "type": "string", "description": "Requirement level of the attribute\n\nEnum: `\"OPTIONAL\"`, `\"REQUIRED\"`, `\"RECOMMENDED\"`, `\"DISABLED\"`\n" }, "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

    This field is deprecated. Use the \"type_parameters\" field instead.

    " }, "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.

    This API is deprecated. Use the \"type_parameter\" field for \"LIST\" attribute types to retrieve the value list code.

    " }, "variant": { "type": "boolean", "description": "Whether or not the attribute is a variation axis. Possible values: true or false" } }, "required": [ "code", "description_translations", "label_translations", "required", "requirement_level", "roles", "type", "type_parameter", "variant" ] }, "PM11_Response_200_Attributes_Channels": { "type": "object", "properties": { "code": { "type": "string", "description": "Channel code" } }, "required": [ "code" ] }, "PM11_Response_200_Attributes_DescriptionTranslations": { "type": "object", "properties": { "locale": { "type": "string", "description": "Locale" }, "value": { "type": "string", "description": "Translation" } }, "required": [ "locale", "value" ] }, "PM11_Response_200_Attributes_LabelTranslations": { "type": "object", "properties": { "locale": { "type": "string", "description": "Locale" }, "value": { "type": "string", "description": "Translation" } }, "required": [ "locale", "value" ] }, "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" } }, "required": [ "parameters", "type" ] }, "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" } }, "required": [ "name", "value" ] }, "PM11_Response_200_Attributes_TypeParameters": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the parameter" }, "value": { "type": "string", "description": "Value of the parameter" } }, "required": [ "name", "value" ] }, "PM11_Response_200_Attributes_Values": { "type": "object", "deprecated": true, "properties": { "code": { "type": "string", "description": "

    Value code

    This API is deprecated. Use the \"type_parameter\" field for \"LIST\" attribute types to retrieve the value list code.

    " } }, "required": [ "code" ] }, "PM11_Response_200_TextCsv_Ext_FileStructure": { "type": "object", "description": "CSV output", "properties": { "channels": { "type": "string", "description": "Channels (A list of codes separated by commas)" }, "code": { "type": "string", "description": "Attribute code" }, "default-value": { "type": "string", "deprecated": true, "description": "

    Default value for value list type attributes

    Use the \"type_parameters\" field for \"LIST\" attribute types to retrieve the default value.

    " }, "description": { "type": "string", "description": "Attribute description" }, "description[xx]": { "type": "string", "description": "The attribute description in a specific language. \"xx\" is replaced by the language code." }, "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[xx]": { "type": "string", "description": "The attribute label in a specific language. \"xx\" is replaced by the language code." }, "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

    This field is deprecated. Use the \"requirement_level\" field instead.

    " }, "requirement-level": { "type": "string", "description": "Requirement level of the attribute\n\nEnum: `\"OPTIONAL\"`, `\"REQUIRED\"`, `\"RECOMMENDED\"`, `\"DISABLED\"`\n" }, "roles": { "type": "string", "description": "Attribute roles (A list of roles separated by commas)" }, "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

    This field is deprecated. Use the \"type-parameters\" field instead.

    " }, "type-parameters": { "type": "string", "description": "Specificities of the attribute type, for example the date format, or the maximum size of a media (A list of 'name|value' separated by commas)" }, "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": "string", "deprecated": true, "description": "A list of authorized values for this attribute" }, "values-list": { "type": "string", "deprecated": true, "description": "

    This code points to the list defining the authorized values for this attribute.

    This API is deprecated. Use the \"type_parameter\" field for \"LIST\" attribute types to retrieve the value list code.

    " }, "variant": { "type": "boolean", "description": "Whether or not the attribute is a variation axis. Possible values: true or false" } }, "required": [ "code", "description[xx]", "label[xx]", "required", "requirement-level", "roles", "type", "type-parameter", "variant" ] }, "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" } }, "required": [ "promotions", "total_count" ] }, "PR01_Response_200_Promotions": { "type": "object", "properties": { "amount_off": { "type": "number", "format": "with decimals", "description": "The amount off of the promotion.
    Only applicable when promotion is of type 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.
    Only applicable when promotion is of type 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", "format": "with decimals", "description": "The percentage off of the promotion.
    Only applicable when promotion is of type 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", "format": "with decimals", "description": "The new offer’s unit price triggered by the promotion.
    Only applicable when promotion is of type 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" }, "uniqueItems": true }, "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\n\nEnum: `\"ACTIVE\"`, `\"PENDING\"`, `\"PENDING_APPROVAL\"`, `\"REJECTED\"`, `\"EXPIRED\"`\n" }, "trigger_offer_ids": { "type": "array", "description": "Offers which trigger the promotion, according to the requested trigger_offer_ids", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "triggers": { "type": "array", "description": "Triggers of the promotion", "items": { "$ref": "#/components/schemas/PR01_Response_200_Promotions_Triggers" }, "uniqueItems": true }, "type": { "type": "string", "description": "Promotion type\n\nEnum: `\"AMOUNT_OFF\"`, `\"FREE_ITEMS\"`, `\"PERCENTAGE_OFF\"`, `\"REDUCED_UNIT_PRICE\"`\n" } }, "required": [ "application_to_cart", "channels", "date_created", "end_date", "internal_description", "internal_id", "last_updated", "medias", "public_descriptions", "reward_on_purchased_items", "start_date", "state", "triggers", "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" } }, "required": [ "identifier" ] }, "PR01_Response_200_Promotions_Channels": { "type": "object", "properties": { "code": { "type": "string", "description": "Channel code" }, "label": { "type": "string", "description": "Channel label" } }, "required": [ "code", "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" } }, "required": [ "locale", "url" ] }, "PR01_Response_200_Promotions_PublicDescriptions": { "type": "object", "properties": { "locale": { "type": "string", "description": "Description's locale" }, "value": { "type": "string", "description": "The description itself" } }, "required": [ "locale", "value" ] }, "PR01_Response_200_Promotions_Triggers": { "type": "object", "properties": { "amount_purchased": { "type": "number", "format": "with decimals", "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\n\nEnum: `\"minimum_quantity\"`, `\"every_quantity\"`, `\"minimum_amount\"`, `\"every_amount\"`\n" } }, "required": [ "type" ] }, "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" } }, "required": [ "internal_description", "internal_id", "reward", "start_date", "trigger" ] }, "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" } }, "required": [ "promo_code" ] }, "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" } }, "required": [ "locale", "value" ] }, "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\n\nEnum: `\"FREE_ITEMS\"`, `\"AMOUNT_OFF\"`, `\"PERCENTAGE_OFF\"`, `\"REDUCED_UNIT_PRICE\"`\n" } }, "required": [ "selection", "type" ] }, "PR03_Request_Reward_AmountOff": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR03_Request_Reward" } ], "properties": { "amount_off": { "type": "number", "format": "with decimals", "description": "The amount off of the promotion." } }, "required": [ "amount_off" ] }, "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." } }, "required": [ "free_items_quantity" ] }, "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", "format": "with decimals", "description": "The percentage off of the promotion." } }, "required": [ "percentage_off" ] }, "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", "format": "with decimals", "description": "The new offer's unit price triggered by the promotion." } }, "required": [ "reduced_unit_price" ] }, "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\n\nEnum: `\"PURCHASED_ITEMS\"`, `\"OFFER\"`, `\"PRODUCT\"`, `\"CATEGORY\"`, `\"BRAND\"`\n" } }, "required": [ "type" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "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" } }, "required": [ "type", "value" ] }, "PR03_Request_Reward_Selection_PurchasedItems": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR03_Request_Reward_Selection" } ], "required": [ "type" ] }, "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\n\nEnum: `\"MINIMUM_QUANTITY\"`, `\"EVERY_QUANTITY\"`, `\"MINIMUM_AMOUNT\"`, `\"EVERY_AMOUNT\"`\n" } }, "required": [ "type" ] }, "PR03_Request_Trigger_EveryAmount": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR03_Request_Trigger" } ], "properties": { "amount_purchased": { "type": "number", "format": "with decimals", "description": "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers." } }, "required": [ "amount_purchased" ] }, "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." } }, "required": [ "quantity_purchased" ] }, "PR03_Request_Trigger_MinimumAmount": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR03_Request_Trigger" } ], "properties": { "amount_purchased": { "type": "number", "format": "with decimals", "description": "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers." } }, "required": [ "amount_purchased" ] }, "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." } }, "required": [ "quantity_purchased" ] }, "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\n\nEnum: `\"ALL\"`, `\"OFFER\"`, `\"PRODUCT\"`, `\"CATEGORY\"`, `\"BRAND\"`\n" } }, "required": [ "type" ] }, "PR03_Request_Trigger_Selection_All": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR03_Request_Trigger_Selection" } ], "required": [ "type" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "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" } }, "required": [ "type", "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" } }, "required": [ "internal_description", "reward", "start_date", "trigger" ] }, "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" } }, "required": [ "promo_code" ] }, "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" } }, "required": [ "locale", "value" ] }, "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" } }, "required": [ "selection" ] }, "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\n\nEnum: `\"PURCHASED_ITEMS\"`, `\"OFFER\"`, `\"PRODUCT\"`, `\"CATEGORY\"`, `\"BRAND\"`\n" } }, "required": [ "type" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "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" } }, "required": [ "type", "value" ] }, "PR04_Request_Reward_Selection_PurchasedItems": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR04_Request_Reward_Selection" } ], "required": [ "type" ] }, "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" } }, "required": [ "selection" ] }, "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\n\nEnum: `\"ALL\"`, `\"OFFER\"`, `\"PRODUCT\"`, `\"CATEGORY\"`, `\"BRAND\"`\n" } }, "required": [ "type" ] }, "PR04_Request_Trigger_Selection_All": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/PR04_Request_Trigger_Selection" } ], "required": [ "type" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "values" ] }, "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" } } }, "required": [ "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" } }, "required": [ "type", "value" ] }, "PRI01_Response_201": { "type": "object", "properties": { "importId": { "type": "string", "deprecated": true, "description": "Offer pricing import identifier" }, "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." } }, "required": [ "data" ] }, "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\n\nEnum: `\"API\"`, `\"FTP\"`, `\"SFTP\"`, `\"HTTP\"`, `\"HTTPS\"`, `\"FRONT\"`, `\"PENDING_OFFERS\"`\n" }, "reason_status": { "type": "string", "description": "Import status reason" }, "shop_id": { "type": "integer", "format": "int64", "description": "Shop identifier" }, "status": { "type": "string", "description": "Import status\n\nEnum: `\"WAITING\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"FAILED\"`\n" } }, "required": [ "date_created", "has_error_report", "import_id", "lines_in_error", "lines_in_success", "offers_in_error", "offers_updated", "origin", "reason_status", "shop_id", "status" ] }, "RE01_Response_200": { "type": "object", "properties": { "reasons": { "type": "array", "description": "List of reasons detailed", "items": { "$ref": "#/components/schemas/RE01_Response_200_Reasons" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count of elements returned by the query (no pagination)" } }, "required": [ "reasons", "total_count" ] }, "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\n\nEnum: `\"INCIDENT_OPEN\"`, `\"MPS_INCIDENT_OPEN\"`, `\"INCIDENT_CLOSE\"`, `\"MPS_INCIDENT_CLOSE\"`, `\"REFUND\"`, `\"MPS_REFUND\"`, `\"ORDER_MESSAGING\"`, `\"MPS_ORDER_MESSAGING\"`, `\"MPS_OFFER_MESSAGING\"`, `\"OFFER_MESSAGING\"`, `\"CANCELATION\"`, `\"MMP_SELLER_MESSAGING\"`, `\"MPS_SELLER_MESSAGING\"`, `\"RETURN\"`, `\"RETURN_REJECTION\"`, `\"RETURN_NON_COMPLIANT\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"MESSAGING\"`\n
    \n" } }, "required": [ "code", "is_shop_right", "label", "type" ] }, "RE02_Response_200": { "type": "object", "properties": { "reasons": { "type": "array", "description": "List of reasons", "items": { "$ref": "#/components/schemas/RE02_Response_200_Reasons" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count of elements returned by the query (No pagination)" } }, "required": [ "reasons", "total_count" ] }, "RE02_Response_200_Reasons": { "type": "object", "properties": { "code": { "type": "string", "description": "Reason code" }, "label": { "type": "string", "description": "Reason label " } }, "required": [ "code", "label" ] }, "RE11_Response_200": { "type": "object", "properties": { "reasons": { "type": "array", "description": "List of reasons", "items": { "$ref": "#/components/schemas/RE11_Response_200_Reasons" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count of elements returned by the query (No pagination)" } }, "required": [ "reasons", "total_count" ] }, "RE11_Response_200_Reasons": { "type": "object", "properties": { "code": { "type": "string", "description": "Reason code" }, "label": { "type": "string", "description": "Reason label " } }, "required": [ "code", "label" ] }, "RE12_Response_200": { "type": "object", "properties": { "reasons": { "type": "array", "description": "List of reasons", "items": { "$ref": "#/components/schemas/RE12_Response_200_Reasons" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count of elements returned by the query (No pagination)" } }, "required": [ "reasons", "total_count" ] }, "RE12_Response_200_Reasons": { "type": "object", "properties": { "code": { "type": "string", "description": "Reason code" }, "label": { "type": "string", "description": "Reason label " } }, "required": [ "code", "label" ] }, "RE14_Response_200": { "type": "object", "properties": { "reasons": { "type": "array", "description": "List of reasons", "items": { "$ref": "#/components/schemas/RE14_Response_200_Reasons" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total count of elements returned by the query (No pagination)" } }, "required": [ "reasons", "total_count" ] }, "RE14_Response_200_Reasons": { "type": "object", "properties": { "code": { "type": "string", "description": "Reason code" }, "label": { "type": "string", "description": "Reason label " } }, "required": [ "code", "label" ] }, "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 } }, "required": [ "returns" ] }, "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\n\nEnum: `\"RETURN_METHOD_BY_MAIL\"`, `\"RETURN_METHOD_DROP_OFF_POINT\"`, `\"RETURN_METHOD_HOME_PICKUP\"`, `\"RETURN_METHOD_IN_STORE\"`, `\"RETURN_METHOD_RETURNLESS\"`\n" }, "order_commercial_id": { "type": "string", "description": "Order commercial id" }, "reason_code": { "type": "string", "description": "Return reason code\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" }, "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_-]+" } }, "required": [ "method_code", "order_commercial_id", "return_lines" ] }, "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." } }, "required": [ "order_line_id", "quantity", "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" } } }, "required": [ "return_errors", "return_success" ] }, "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\n\nEnum: `\"RETURN_METHOD_BY_MAIL\"`, `\"RETURN_METHOD_DROP_OFF_POINT\"`, `\"RETURN_METHOD_HOME_PICKUP\"`, `\"RETURN_METHOD_IN_STORE\"`, `\"RETURN_METHOD_RETURNLESS\"`\n" }, "order_commercial_id": { "type": "string", "description": "Order commercial id" }, "order_id": { "type": "string", "description": "Order id" }, "reason_code": { "type": "string", "description": "Return reason code\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" }, "rejection_reason_code": { "type": "string", "description": "Return rejection reason code\n\nEnum: `\"RETURN_REJECTION_NOT_ELIGIBLE\"`, `\"RETURN_REJECTION_NOT_NEEDED\"`, `\"RETURN_REJECTION_WINDOW_CLOSED\"`\n" }, "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\n\nEnum: `\"WAITING_ACCEPTANCE\"`, `\"IN_PROGRESS\"`, `\"REFUSED\"`, `\"RECEIVED\"`, `\"NO_RECEPTION\"`, `\"CLOSED\"`, `\"CANCELED\"`\n" }, "tracking": { "$ref": "#/components/schemas/RT01_Response_200_ReturnSuccess_Tracking", "description": "Return tracking details" } }, "required": [ "date_created", "id", "last_updated", "method_code", "order_commercial_id", "order_id", "return_address", "return_lines", "state" ] }, "RT01_Response_200_ReturnSuccess_Documents": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Return document id" }, "type": { "type": "string", "description": "Return document type" } }, "required": [ "id", "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" } }, "required": [ "city", "country_iso_code", "street1", "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.\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" } }, "required": [ "order_line_id", "quantity", "reason_code" ] }, "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" } }, "required": [ "compliant" ] }, "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 } }, "required": [ "returns" ] }, "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.\n\nEnum: `\"RETURN_METHOD_BY_MAIL\"`, `\"RETURN_METHOD_DROP_OFF_POINT\"`, `\"RETURN_METHOD_HOME_PICKUP\"`, `\"RETURN_METHOD_IN_STORE\"`, `\"RETURN_METHOD_RETURNLESS\"`\n" }, "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" } }, "required": [ "id" ] }, "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\n\nEnum: `\"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\"`\n" }, "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 } }, "required": [ "city", "country_iso_code", "street1" ] }, "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\n\nEnum: `\"RETURN_METHOD_BY_MAIL\"`, `\"RETURN_METHOD_DROP_OFF_POINT\"`, `\"RETURN_METHOD_HOME_PICKUP\"`, `\"RETURN_METHOD_IN_STORE\"`, `\"RETURN_METHOD_RETURNLESS\"`\n" }, "order_commercial_id": { "type": "string", "description": "Order commercial id" }, "order_id": { "type": "string", "description": "Order id" }, "reason_code": { "type": "string", "description": "Return reason code\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" }, "rejection_reason_code": { "type": "string", "description": "Return rejection reason code\n\nEnum: `\"RETURN_REJECTION_NOT_ELIGIBLE\"`, `\"RETURN_REJECTION_NOT_NEEDED\"`, `\"RETURN_REJECTION_WINDOW_CLOSED\"`\n" }, "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\n\nEnum: `\"WAITING_ACCEPTANCE\"`, `\"IN_PROGRESS\"`, `\"REFUSED\"`, `\"RECEIVED\"`, `\"NO_RECEPTION\"`, `\"CLOSED\"`, `\"CANCELED\"`\n" }, "tracking": { "$ref": "#/components/schemas/RT04_Response_200_ReturnSuccess_Tracking", "description": "Return tracking details" } }, "required": [ "date_created", "id", "last_updated", "method_code", "order_commercial_id", "order_id", "return_address", "return_lines", "state" ] }, "RT04_Response_200_ReturnSuccess_Documents": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Return document id" }, "type": { "type": "string", "description": "Return document type" } }, "required": [ "id", "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" } }, "required": [ "city", "country_iso_code", "street1", "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.\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" } }, "required": [ "order_line_id", "quantity", "reason_code" ] }, "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" } }, "required": [ "compliant" ] }, "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." } }, "required": [ "data" ] }, "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\n\nEnum: `\"RETURN_METHOD_BY_MAIL\"`, `\"RETURN_METHOD_DROP_OFF_POINT\"`, `\"RETURN_METHOD_HOME_PICKUP\"`, `\"RETURN_METHOD_IN_STORE\"`, `\"RETURN_METHOD_RETURNLESS\"`\n" }, "order_commercial_id": { "type": "string", "description": "Order commercial id" }, "order_id": { "type": "string", "description": "Order id" }, "reason_code": { "type": "string", "description": "Return reason code\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" }, "rejection_reason_code": { "type": "string", "description": "Return rejection reason code\n\nEnum: `\"RETURN_REJECTION_NOT_ELIGIBLE\"`, `\"RETURN_REJECTION_NOT_NEEDED\"`, `\"RETURN_REJECTION_WINDOW_CLOSED\"`\n" }, "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\n\nEnum: `\"WAITING_ACCEPTANCE\"`, `\"IN_PROGRESS\"`, `\"REFUSED\"`, `\"RECEIVED\"`, `\"NO_RECEPTION\"`, `\"CLOSED\"`, `\"CANCELED\"`\n" }, "tracking": { "$ref": "#/components/schemas/RT11_Response_200_Data_Tracking", "description": "Return tracking details" } }, "required": [ "date_created", "id", "last_updated", "method_code", "order_commercial_id", "order_id", "return_address", "return_lines", "state" ] }, "RT11_Response_200_Data_Documents": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Return document id" }, "type": { "type": "string", "description": "Return document type" } }, "required": [ "id", "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" } }, "required": [ "city", "country_iso_code", "street1", "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.\n\nEnum: `\"RETURN_BROKEN_ITEM\"`, `\"RETURN_CHANGED_MIND\"`, `\"RETURN_COUNTERFEIT_ITEM\"`, `\"RETURN_DAMAGED_PACKAGING\"`, `\"RETURN_DEFECTIVE_ITEM\"`, `\"RETURN_DELIVERED_PRODUCT_DIFFERENT\"`, `\"RETURN_MISSING_ITEM\"`, `\"RETURN_OTHER\"`, `\"RETURN_CM_DONT_WANT\"`, `\"RETURN_CM_DONT_LIKE\"`, `\"RETURN_CM_QUALITY\"`, `\"RETURN_DPD_WRONG_SIZE\"`, `\"RETURN_DPD_WRONG_COLOR\"`, `\"RETURN_DEFECTIVE_ON_ARRIVAL\"`, `\"RETURN_PRODUCT_DOES_NOT_FIT\"`, `\"RETURN_PDNT_TOO_BIG\"`, `\"RETURN_PDNT_TOO_SMALL\"`, `\"RETURN_INACCURATE_ITEM_DESCRIPTION\"`, `\"RETURN_WARRANTY\"`\n" } }, "required": [ "order_line_id", "quantity", "reason_code" ] }, "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" } }, "required": [ "compliant" ] }, "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." } }, "required": [ "data" ] }, "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" } }, "required": [ "order_commercial_id", "order_line_id", "returnable_quantity" ] }, "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 } }, "required": [ "returns" ] }, "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\n\nEnum: `\"RETURN_REJECTION_NOT_ELIGIBLE\"`, `\"RETURN_REJECTION_NOT_NEEDED\"`, `\"RETURN_REJECTION_WINDOW_CLOSED\"`\n" } }, "required": [ "accepted", "id" ] }, "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 } }, "required": [ "id" ] }, "RT25_Request": { "type": "object", "properties": { "returns": { "type": "array", "description": "Return ids", "items": { "$ref": "#/components/schemas/RT25_Request_Returns" }, "maxItems": 100, "minItems": 1 } }, "required": [ "returns" ] }, "RT25_Request_Returns": { "type": "object", "description": "Return ids", "properties": { "id": { "type": "string", "description": "Return id, must be a valid UUID", "maxLength": 36, "minLength": 0 } }, "required": [ "id" ] }, "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": { "code": { "type": "string", "description": "Stable, machine-readable error code" }, "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 } }, "required": [ "id" ] }, "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 } }, "required": [ "returns" ] }, "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 } }, "required": [ "id", "return_lines" ] }, "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\n\nEnum: `\"RETURN_NON_COMPLIANT_MISSING_ITEM\"`, `\"RETURN_NON_COMPLIANT_WRONG_PRODUCT\"`, `\"RETURN_NON_COMPLIANT_DAMAGED_PRODUCT\"`, `\"RETURN_NON_COMPLIANT_WINDOW_CLOSED\"`, `\"RETURN_NON_COMPLIANT_OTHER\"`\n" }, "order_line_id": { "type": "string", "description": "Order line id" } }, "required": [ "compliant", "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 } }, "required": [ "id" ] }, "RT27_Request": { "type": "object", "properties": { "returns": { "type": "array", "description": "Return ids", "items": { "$ref": "#/components/schemas/RT27_Request_Returns" }, "maxItems": 100, "minItems": 1 } }, "required": [ "returns" ] }, "RT27_Request_Returns": { "type": "object", "description": "Return ids", "properties": { "id": { "type": "string", "description": "Return id, must be a valid UUID", "maxLength": 36, "minLength": 0 } }, "required": [ "id" ] }, "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": { "code": { "type": "string", "description": "Stable, machine-readable error code" }, "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 } }, "required": [ "id" ] }, "RT29_Request": { "type": "object", "properties": { "returns": { "type": "array", "description": "Return ids", "items": { "$ref": "#/components/schemas/RT29_Request_Returns" }, "maxItems": 100, "minItems": 1 } }, "required": [ "returns" ] }, "RT29_Request_Returns": { "type": "object", "description": "Return ids", "properties": { "id": { "type": "string", "description": "Return id, must be a valid UUID", "maxLength": 36, "minLength": 0 } }, "required": [ "id" ] }, "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 } }, "required": [ "id" ] }, "RT51_Request": { "type": "object", "properties": { "return_labels": { "type": "array", "description": "Returns list", "items": { "$ref": "#/components/schemas/RT51_Request_ReturnLabels" }, "maxItems": 200, "minItems": 0 } }, "required": [ "return_labels" ] }, "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.\n\nEnum: `\"CHEAPEST\"`\n" }, "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." } }, "required": [ "package", "return_id" ] }, "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" } }, "required": [ "dimensions", "weight" ] }, "RT51_Request_ReturnLabels_Package_Dimensions": { "type": "object", "description": "Physical dimensions of the package", "properties": { "height": { "type": "number", "format": "with decimals", "description": "package height", "maximum": 10000, "minimum": 0 }, "length": { "type": "number", "format": "with decimals", "description": "package length", "maximum": 10000, "minimum": 0 }, "unit": { "type": "string", "description": "Dimension unit", "pattern": "^(in|cm)$" }, "width": { "type": "number", "format": "with decimals", "description": "package width", "maximum": 10000, "minimum": 0 } }, "required": [ "height", "length", "unit", "width" ] }, "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", "format": "with decimals", "description": "Numeric weight value", "maximum": 1000000, "minimum": 0 } }, "required": [ "unit", "value" ] }, "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" } }, "required": [ "city", "contact_name", "contact_phone", "country_iso_code", "street_1" ] }, "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." } }, "required": [ "data" ] }, "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\n\nEnum: `\"PENDING\"`, `\"CREATED\"`, `\"FAILED\"`\n" }, "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" } }, "required": [ "date_created", "label_state", "last_updated", "return_id" ] }, "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", "format": "with decimals", "description": "Label cost amount" }, "currency_iso_code": { "type": "string", "description": "Label currency (iso format)\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" } } }, "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" } }, "total_count": { "type": "integer", "format": "int32", "deprecated": true, "description": "Total number of documents" } }, "required": [ "shop_documents" ] }, "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" } }, "required": [ "file_name", "id", "type" ] }, "S32_Request_MultipartFormData_ShopDocuments": { "type": "object", "properties": { "shop_documents": { "type": "array", "description": "Shop documents", "items": { "$ref": "#/components/schemas/S32_Request_MultipartFormData_ShopDocuments_ShopDocuments" } } }, "required": [ "shop_documents" ] }, "S32_Request_MultipartFormData_ShopDocuments_ShopDocuments": { "type": "object", "description": "Shop documents", "properties": { "file_name": { "type": "string", "description": "File name" }, "type_code": { "type": "string", "description": "Document type code" } }, "required": [ "file_name", "type_code" ] }, "S32_Response_200": { "type": "object", "properties": { "documents": { "type": "array", "description": "List of error reports associated to each document in an error state", "items": { "$ref": "#/components/schemas/S32_Response_200_Documents" } }, "errors_count": { "type": "integer", "format": "int32", "description": "The number of documents in an error state" } }, "required": [ "documents" ] }, "S32_Response_200_Documents": { "type": "object", "properties": { "errors": { "type": "array", "description": "Errors about the input object", "items": { "$ref": "#/components/schemas/S32_Response_200_Documents_Errors" }, "uniqueItems": true } }, "required": [ "errors" ] }, "S32_Response_200_Documents_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" } }, "required": [ "code", "field", "message" ] }, "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." } }, "required": [ "data" ] }, "SBC11_Response_200_Data": { "type": "object", "properties": { "amount_transferred_to_operator": { "type": "number", "format": "with decimals", "description": "Total amount to be transferred to the operator" }, "amount_transferred_to_seller": { "type": "number", "format": "with decimals", "description": "Total amount to be transferred to the seller" }, "currency_iso_code": { "type": "string", "description": "The currency of the shop\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "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\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" }, "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\n\nEnum: `\"INCOMPLETE_KYC\"`, `\"AWAITING_INVOICE_CHECK\"`\n" }, "reference": { "type": "string", "description": "Pay-out reference, present only when state is PAID" }, "state": { "type": "string", "description": "Pay-out state\n\nEnum: `\"TO_PAY\"`, `\"PAID\"`, `\"FAILED\"`\n" }, "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\n\nEnum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n" }, "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", "format": "with decimals", "description": "Total amount of commissions (excluding taxes on orders)" }, "total_commissions_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of commissions (including taxes on orders)" }, "total_fee_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees (excluding taxes on orders)" }, "total_fee_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees (including taxes on orders)" }, "total_fee_operator_remitted_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees remitted by the operator (excluding taxes on orders)" }, "total_fee_operator_remitted_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of fees remitted by the operator (including taxes on orders)" }, "total_mirakl_ads_credit_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads credits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_credit_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads credits of a payment cycle (including taxes on stores)" }, "total_mirakl_ads_debit_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads debits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_debit_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for Mirakl Ads debits of a payment cycle (including taxes on stores)" }, "total_non_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_non_payable_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for non payable orders (including shipping charges and taxes on orders)" }, "total_operator_paid_shipping_charges_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of shipping charges paid by the operator (excluding taxes on orders)" }, "total_operator_paid_shipping_charges_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of shipping charges paid by the operator (including taxes on orders)" }, "total_operator_remitted_taxes": { "type": "number", "format": "with decimals", "description": "Total amount for order taxes remitted by the operator" }, "total_other_credits_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual credits of a payment cycle (excluding taxes on stores)" }, "total_other_credits_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual credits of a payment cycle (including taxes on stores)" }, "total_other_invoices_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual invoices of a payment cycle (excluding taxes on stores)" }, "total_other_invoices_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for other manual invoices of a payment cycle (including taxes on stores)" }, "total_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for payable orders including shipping charges (excluding taxes on orders)" }, "total_payable_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount for payable orders including taxes (including taxes on orders)" }, "total_purchase_taxes": { "type": "number", "format": "with decimals", "description": "Total amount for purchase taxes" }, "total_refund_commissions_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded commissions (excluding taxes on orders)" }, "total_refund_commissions_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded commissions (including taxes on orders)" }, "total_refund_fee_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees (excluding taxes on orders)" }, "total_refund_fee_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees (including taxes on orders)" }, "total_refund_fee_operator_remitted_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees remitted by the operator (excluding taxes on orders)" }, "total_refund_fee_operator_remitted_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded fees remitted by the operator (including taxes on orders)" }, "total_refund_non_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "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", "format": "with decimals", "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", "format": "with decimals", "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", "format": "with decimals", "description": "Total amount of refunded shipping charges paid by the operator (including taxes on orders)" }, "total_refund_operator_remitted_taxes": { "type": "number", "format": "with decimals", "description": "Total amount of refunded taxes remitted by the operator" }, "total_refund_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded orders (excluding all refunded taxes)" }, "total_refund_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of refunded orders (including all refunded taxes)" }, "total_refund_payable_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount refunded for payable orders (excluding taxes on orders)" }, "total_refund_payable_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount refunded for payable orders (including taxes on orders)" }, "total_refund_purchase_taxes": { "type": "number", "format": "with decimals", "description": "Total amount of refunded purchase taxes" }, "total_seller_fees_on_orders_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller fees on orders (excluding taxes on orders)" }, "total_seller_fees_on_orders_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller fees on orders (including taxes on orders)" }, "total_seller_penalty_fees_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller penalty fees (excluding taxes on orders)" }, "total_seller_penalty_fees_incl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of seller penalty fees (including taxes on orders)" }, "total_subscription_excl_tax": { "type": "number", "format": "with decimals", "description": "Total amount of subscription fees (excluding taxes on stores)" }, "total_subscription_incl_tax": { "type": "number", "format": "with decimals", "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" } } }, "required": [ "shipping_zones" ] }, "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 " } }, "required": [ "code", "description", "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" } }, "required": [ "click_and_collect", "code", "delivery_by_operator", "description", "label", "mandatory_tracking" ] }, "SH21_Response_200": { "type": "object", "properties": { "carriers": { "type": "array", "description": "List of carriers", "items": { "$ref": "#/components/schemas/SH21_Response_200_Carriers" } } }, "required": [ "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" } }, "required": [ "code", "label" ] }, "SH31_Response_200": { "type": "object", "properties": { "logistic_classes": { "type": "array", "description": "List of logistic classes", "items": { "$ref": "#/components/schemas/SH31_Response_200_LogisticClasses" } } }, "required": [ "logistic_classes" ] }, "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 " } }, "required": [ "code", "description", "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" } }, "required": [ "delivery_times", "lead_time_to_ship", "order_cut_off_times", "order_free_shipping", "shipping_paid_by_operator", "shop_id" ] }, "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\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`\n" }, "shipping_type_code": { "type": "string", "description": "Shipping type code" }, "shipping_zone_code": { "type": "string", "description": "Shipping zone code" } }, "required": [ "set_by", "shipping_type_code", "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" } }, "required": [ "earliest_days", "latest_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" } }, "required": [ "default_value", "shop_value" ] }, "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\n\nEnum: `\"OPERATOR\"`, `\"SHOP\"`, `\"NOT_NEEDED\"`\n" }, "shipping_type_code": { "type": "string", "description": "Shipping type code" } }, "required": [ "cut_off_time", "is_required", "set_by", "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.\n\nEnum: `\"AED\"`, `\"ARS\"`, `\"AUD\"`, `\"BAM\"`, `\"BGN\"`, `\"BHD\"`, `\"BRL\"`, `\"CAD\"`, `\"CHF\"`, `\"CLP\"`, `\"CNY\"`, `\"COP\"`, `\"CZK\"`, `\"DKK\"`, `\"EGP\"`, `\"EUR\"`, `\"GBP\"`, `\"GEL\"`, `\"GTQ\"`, `\"HKD\"`, `\"HRK\"`, `\"HUF\"`, `\"IDR\"`, `\"ILS\"`, `\"INR\"`, `\"IQD\"`, `\"JOD\"`, `\"JPY\"`, `\"KES\"`, `\"KRW\"`, `\"KWD\"`, `\"LKR\"`, `\"MAD\"`, `\"MGA\"`, `\"MXN\"`, `\"MYR\"`, `\"NGN\"`, `\"NOK\"`, `\"NZD\"`, `\"OMR\"`, `\"PEN\"`, `\"PHP\"`, `\"PKR\"`, `\"PLN\"`, `\"QAR\"`, `\"RON\"`, `\"RSD\"`, `\"RUB\"`, `\"SAR\"`, `\"SEK\"`, `\"SGD\"`, `\"TND\"`, `\"TRY\"`, `\"THB\"`, `\"TWD\"`, `\"UAH\"`, `\"USD\"`, `\"UYU\"`, `\"UZS\"`, `\"VND\"`, `\"ZAR\"`\n" }, "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." } }, "required": [ "configuration", "currency_iso_code", "last_updated_date", "shop_id" ] }, "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." } }, "required": [ "logistic_class_code", "overridden_by_shop", "prices", "shipping_method_code", "shipping_zone_code" ] }, "SH52_Response_200_Configuration_Prices": { "type": "object", "properties": { "additional_price": { "type": "number", "format": "with decimals", "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", "format": "with decimals", "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", "format": "with decimals", "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.\n\nEnum: `\"FIXED_PRICE\"`, `\"FREE_SHIPPING\"`, `\"ORDER_RANGE\"`\n" } }, "required": [ "type" ] }, "SH52_Response_200_Configuration_Prices_Ranges": { "type": "object", "properties": { "price": { "type": "number", "format": "with decimals", "description": "The value of the shipping price." }, "threshold": { "type": "number", "format": "with decimals", "description": "The threshold amounts from which the configured shipping price applies." } }, "required": [ "price", "threshold" ] }, "ST01_Request": { "type": "object", "properties": { "shipments": { "type": "array", "description": "Shipments list", "items": { "$ref": "#/components/schemas/ST01_Request_Shipments" }, "maxItems": 1000, "minItems": 1 } }, "required": [ "shipments" ] }, "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" } }, "required": [ "order_id", "shipment_lines" ] }, "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\n\nEnum: `\"STRING\"`, `\"DATE\"`\n" }, "value": { "type": "object", "description": "The value associated to the shipment additional information that you want to complete for this specific shipment" } }, "required": [ "code", "type", "value" ] }, "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" } }, "required": [ "value" ] }, "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" } }, "required": [ "value" ] }, "ST01_Request_Shipments_ShipmentLines": { "type": "object", "description": "Shipment lines", "properties": { "offer_sku": { "type": "string", "deprecated": true, "description": "

    Offer sku

    Use order_line_id instead

    " }, "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 } }, "required": [ "quantity" ] }, "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" } } }, "required": [ "shipment_errors", "shipment_success" ] }, "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\n\nEnum: `\"SHIPPING\"`, `\"READY_FOR_PICK_UP\"`, `\"SHIPMENT_PREPARED\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CANCELED\"`, `\"CLOSED\"`\n" }, "status_customer_debit": { "type": "string", "description": "Shipment debit status\n\nEnum: `\"NO_DEBIT\"`, `\"NOT_STARTED\"`, `\"WAITING_TAX_CONFIRMATION\"`, `\"WAITING_OPERATOR_SYSTEM_CONTACT\"`, `\"WAITING_DEBIT_CONFIRMATION\"`, `\"DEBIT_OK\"`, `\"CANCELED\"`\n" }, "tracking": { "$ref": "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking", "description": "Shipment tracking details" } }, "required": [ "created_date", "id", "last_updated_date", "order_id", "status", "status_customer_debit" ] }, "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" } }, "required": [ "customer_debited_date", "transaction_date" ] }, "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\n\nEnum: `\"STRING\"`, `\"DATE\"`\n" } } }, "ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation" } ], "example": { "code": "DELIVERY_BILL_DATE", "type": "DATE", "value": "2013-10-21" }, "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" } ], "example": { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "deliveryBillId" }, "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

    Use order_line_id instead

    " }, "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 } }, "required": [ "quantity" ] }, "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\n\nEnum: `\"MISSING_TRACKING\"`, `\"UNVERIFIED\"`, `\"UNCOVERED\"`, `\"INVALID\"`, `\"VERIFIED\"`\n" } } }, "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\n\nEnum: `\"IN_TRANSIT\"`, `\"OUT_FOR_DELIVERY\"`, `\"TO_COLLECT\"`, `\"DELIVERED\"`, `\"EXCEPTION\"`\n" } } }, "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\n\nEnum: `\"DESTINATION_ARRIVAL\"`, `\"DATA_ORDER_CANCELLED\"`, `\"DATA_DELIVERY_PROPOSED\"`, `\"DATA_DELIVERY_DECIDED\"`, `\"CUSTOMS_RECEIVED\"`, `\"CUSTOMS_EXCEPTION\"`, `\"CUSTOMS_CLEARED\"`, `\"CUSTOMS_REJECTED\"`, `\"DELIVERY_ATTEMPTED\"`, `\"DELIVERY_EXCEPTION\"`\n" } } }, "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 } }, "required": [ "shipments" ] }, "ST06_Request_Shipments": { "type": "object", "description": "Shipment ids", "properties": { "id": { "type": "string", "description": "Shipment id", "maxLength": 2147483647, "minLength": 1 } }, "required": [ "id" ] }, "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 } }, "required": [ "id" ] }, "ST07_Request": { "type": "object", "properties": { "shipments": { "type": "array", "description": "Shipments list", "items": { "$ref": "#/components/schemas/ST07_Request_Shipments" }, "maxItems": 100, "minItems": 1 } }, "required": [ "shipments" ] }, "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" } }, "required": [ "id", "shipping_from" ] }, "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" } }, "required": [ "warehouse" ] }, "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" } }, "required": [ "code" ] }, "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" } } }, "required": [ "shipment_errors", "shipment_success" ] }, "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." } }, "required": [ "data" ] }, "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\n\nEnum: `\"SHIPPING\"`, `\"READY_FOR_PICK_UP\"`, `\"SHIPMENT_PREPARED\"`, `\"SHIPPED\"`, `\"TO_COLLECT\"`, `\"RECEIVED\"`, `\"CANCELED\"`, `\"CLOSED\"`\n" }, "status_customer_debit": { "type": "string", "description": "Shipment debit status\n\nEnum: `\"NO_DEBIT\"`, `\"NOT_STARTED\"`, `\"WAITING_TAX_CONFIRMATION\"`, `\"WAITING_OPERATOR_SYSTEM_CONTACT\"`, `\"WAITING_DEBIT_CONFIRMATION\"`, `\"DEBIT_OK\"`, `\"CANCELED\"`\n" }, "tracking": { "$ref": "#/components/schemas/ST11_Response_200_Data_Tracking", "description": "Shipment tracking details" } }, "required": [ "created_date", "id", "last_updated_date", "order_id", "status", "status_customer_debit" ] }, "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" } }, "required": [ "customer_debited_date", "transaction_date" ] }, "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\n\nEnum: `\"STRING\"`, `\"DATE\"`\n" } } }, "ST11_Response_200_Data_ShipmentAdditionalInformation_Date": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation" } ], "example": { "code": "DELIVERY_BILL_DATE", "type": "DATE", "value": "2013-10-21" }, "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" } ], "example": { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "deliveryBillId" }, "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

    Use order_line_id instead

    " }, "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 } }, "required": [ "quantity" ] }, "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\n\nEnum: `\"MISSING_TRACKING\"`, `\"UNVERIFIED\"`, `\"UNCOVERED\"`, `\"INVALID\"`, `\"VERIFIED\"`\n" } } }, "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\n\nEnum: `\"IN_TRANSIT\"`, `\"OUT_FOR_DELIVERY\"`, `\"TO_COLLECT\"`, `\"DELIVERED\"`, `\"EXCEPTION\"`\n" } } }, "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\n\nEnum: `\"DESTINATION_ARRIVAL\"`, `\"DATA_ORDER_CANCELLED\"`, `\"DATA_DELIVERY_PROPOSED\"`, `\"DATA_DELIVERY_DECIDED\"`, `\"CUSTOMS_RECEIVED\"`, `\"CUSTOMS_EXCEPTION\"`, `\"CUSTOMS_CLEARED\"`, `\"CUSTOMS_REJECTED\"`, `\"DELIVERY_ATTEMPTED\"`, `\"DELIVERY_EXCEPTION\"`\n" } } }, "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." } }, "required": [ "data" ] }, "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" } }, "required": [ "order_id", "shipping_address", "shipping_date", "shipping_type_code" ] }, "ST12_Response_200_Data_Fulfillment": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/ST12_Response_200_Data_Fulfillment_Center", "description": "Fulfillment center code" } }, "required": [ "center" ] }, "ST12_Response_200_Data_Fulfillment_Center": { "type": "object", "properties": { "code": { "type": "string", "description": "Center code" } }, "required": [ "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

    This field has been deprecated and will be removed in future version of Mirakl.

    " }, "package_reference": { "type": "string", "description": "Package reference" }, "product_title": { "type": "string", "description": "Product title" }, "quantity": { "type": "integer", "format": "int32", "description": "Quantity", "minimum": 1 } }, "required": [ "quantity" ] }, "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\n\nEnum: `\"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\"`\n" }, "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, mandatory except if country_iso_code = \"JPN\"." }, "street_2": { "type": "string", "description": "Second information line of the address street" }, "zip_code": { "type": "string", "description": "Address zip code" } }, "required": [ "city", "country", "country_iso_code", "lastname", "street_1" ] }, "ST23_Request": { "type": "object", "properties": { "shipments": { "type": "array", "description": "Shipments list", "items": { "$ref": "#/components/schemas/ST23_Request_Shipments" }, "maxItems": 1000, "minItems": 1 } }, "required": [ "shipments" ] }, "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" } }, "required": [ "id", "tracking" ] }, "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 } }, "required": [ "id" ] }, "ST24_Request": { "type": "object", "properties": { "shipments": { "type": "array", "description": "Shipment ids", "items": { "$ref": "#/components/schemas/ST24_Request_Shipments" }, "maxItems": 1000, "minItems": 1 } }, "required": [ "shipments" ] }, "ST24_Request_Shipments": { "type": "object", "description": "Shipment ids", "properties": { "id": { "type": "string", "description": "Shipment id", "maxLength": 2147483647, "minLength": 1 } }, "required": [ "id" ] }, "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 } }, "required": [ "id" ] }, "ST26_Request": { "type": "object", "properties": { "shipments": { "type": "array", "description": "Shipment ids", "items": { "$ref": "#/components/schemas/ST26_Request_Shipments" }, "maxItems": 1000, "minItems": 1 } }, "required": [ "shipments" ] }, "ST26_Request_Shipments": { "type": "object", "description": "Shipment ids", "properties": { "id": { "type": "string", "description": "Shipment id", "maxLength": 2147483647, "minLength": 1 } }, "required": [ "id" ] }, "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 } }, "required": [ "id" ] }, "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 } }, "required": [ "shipments" ] }, "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" } } }, "required": [ "id", "shipment_additional_information" ] }, "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\n\nEnum: `\"STRING\"`, `\"DATE\"`\n" }, "value": { "type": "object", "description": "The value associated to the shipment additional information that you want to complete for this specific shipment" } }, "required": [ "code", "type", "value" ] }, "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" } }, "required": [ "value" ] }, "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" } }, "required": [ "value" ] }, "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" } }, "required": [ "code", "field", "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\n\nEnum: `\"STRING\"`, `\"DATE\"`\n" }, "value": { "type": "object", "description": "The value associated to the shipment additional information that you want to complete for this specific shipment" } }, "required": [ "code", "type", "value" ] }, "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" } }, "required": [ "value" ] }, "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" } }, "required": [ "value" ] }, "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\n\nEnum: `\"WAITING\"`, `\"RUNNING\"`, `\"COMPLETE\"`, `\"FAILED\"`\n" } }, "required": [ "date_created", "has_error_report", "import_id", "shop_id", "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." } }, "required": [ "data" ] }, "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", "format": "with decimals", "description": "The amount." }, "amount_credited": { "type": "number", "format": "with decimals", "description": "The amount credited." }, "amount_debited": { "type": "number", "format": "with decimals", "description": "The amount debited." }, "balance": { "type": "number", "format": "with decimals", "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.\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" }, "payment_state": { "type": "string", "description": "The payment state of the transaction.\n\nEnum: `\"PENDING\"`, `\"PAYABLE\"`, `\"PAID\"`, `\"NOT_APPLICABLE\"`, `\"RESERVE\"`\n" }, "psp_balance": { "type": "number", "format": "with decimals", "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 ...)\n\nEnum: `\"MANUAL_CREDIT\"`, `\"MANUAL_CREDIT_VAT\"`, `\"MANUAL_INVOICE\"`, `\"MANUAL_INVOICE_VAT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT_TAX\"`, `\"INVOICEABLE_ONE_OFF_CREDIT\"`, `\"INVOICEABLE_ONE_OFF_CREDIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT_TAX\"`, `\"ORDER_AMOUNT\"`, `\"ORDER_AMOUNT_TAX\"`, `\"ORDER_SHIPPING_AMOUNT\"`, `\"ORDER_SHIPPING_AMOUNT_TAX\"`, `\"COMMISSION_FEE\"`, `\"COMMISSION_VAT\"`, `\"REFUND_ORDER_AMOUNT\"`, `\"REFUND_ORDER_AMOUNT_TAX\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_COMMISSION_FEE\"`, `\"REFUND_COMMISSION_VAT\"`, `\"SUBSCRIPTION_FEE\"`, `\"SUBSCRIPTION_VAT\"`, `\"OPERATOR_REMITTED_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"PAYMENT\"`, `\"PURCHASE_COMMISSION_FEE\"`, `\"PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"PURCHASE_ORDER_AMOUNT_TAX\"`, `\"PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_ORDER_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_ORDER_FEE_AMOUNT\"`, `\"REFUND_ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_FEE_AMOUNT\"`, `\"PURCHASE_FEE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_FEE_COMMISSION_FEE\"`, `\"RESERVE_FUNDING\"`, `\"RESERVE_SETTLEMENT\"`, `\"SELLER_FEE_ON_ORDER\"`, `\"SELLER_FEE_ON_ORDER_TAX\"`, `\"SELLER_PENALTY_FEE\"`, `\"SELLER_PENALTY_FEE_TAX\"`\n" } } }, "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": { "emission_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "The manual accounting document emission date." }, "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", "format": "with decimals", "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", "format": "with decimals", "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.
    Nb: This field will be set for line of type COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT" }, "rate": { "type": "number", "format": "with decimals", "description": "Shop tax rate applied
    Nb: This field will be set for line of type COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT
    For backward-compatibility reason, this field will be filled for lines of type COMMISSION_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.\n\nEnum: `\"JSON\"`, `\"NDJSON\"`\n" }, "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", "description": "Enum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" } }, "payment_state": { "type": "array", "description": "Payment state. This parameter can be supplied multiple times.", "items": { "type": "string", "description": "Enum: `\"PENDING\"`, `\"PAYABLE\"`, `\"PAID\"`, `\"NOT_APPLICABLE\"`, `\"RESERVE\"`\n" }, "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", "description": "Enum: `\"MARKETPLACE\"`, `\"DROPSHIP\"`, `\"ONE_CREDITOR\"`\n" } }, "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", "description": "Enum: `\"MANUAL_CREDIT\"`, `\"MANUAL_CREDIT_VAT\"`, `\"MANUAL_INVOICE\"`, `\"MANUAL_INVOICE_VAT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT_TAX\"`, `\"INVOICEABLE_ONE_OFF_CREDIT\"`, `\"INVOICEABLE_ONE_OFF_CREDIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT_TAX\"`, `\"ORDER_AMOUNT\"`, `\"ORDER_AMOUNT_TAX\"`, `\"ORDER_SHIPPING_AMOUNT\"`, `\"ORDER_SHIPPING_AMOUNT_TAX\"`, `\"COMMISSION_FEE\"`, `\"COMMISSION_VAT\"`, `\"REFUND_ORDER_AMOUNT\"`, `\"REFUND_ORDER_AMOUNT_TAX\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_COMMISSION_FEE\"`, `\"REFUND_COMMISSION_VAT\"`, `\"SUBSCRIPTION_FEE\"`, `\"SUBSCRIPTION_VAT\"`, `\"OPERATOR_REMITTED_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"PAYMENT\"`, `\"PURCHASE_COMMISSION_FEE\"`, `\"PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"PURCHASE_ORDER_AMOUNT_TAX\"`, `\"PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_ORDER_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_ORDER_FEE_AMOUNT\"`, `\"REFUND_ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_FEE_AMOUNT\"`, `\"PURCHASE_FEE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_FEE_COMMISSION_FEE\"`, `\"RESERVE_FUNDING\"`, `\"RESERVE_SETTLEMENT\"`, `\"SELLER_FEE_ON_ORDER\"`, `\"SELLER_FEE_ON_ORDER_TAX\"`, `\"SELLER_PENALTY_FEE\"`, `\"SELLER_PENALTY_FEE_TAX\"`\n" }, "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" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure": { "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", "format": "with decimals", "description": "The amount." }, "amount_credited": { "type": "number", "format": "with decimals", "description": "The amount credited." }, "amount_debited": { "type": "number", "format": "with decimals", "description": "The amount debited." }, "balance": { "type": "number", "format": "with decimals", "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/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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.\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" }, "payment_state": { "type": "string", "description": "The payment state of the transaction.\n\nEnum: `\"PENDING\"`, `\"PAYABLE\"`, `\"PAID\"`, `\"NOT_APPLICABLE\"`, `\"RESERVE\"`\n" }, "psp_balance": { "type": "number", "format": "with decimals", "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 ...)\n\nEnum: `\"MANUAL_CREDIT\"`, `\"MANUAL_CREDIT_VAT\"`, `\"MANUAL_INVOICE\"`, `\"MANUAL_INVOICE_VAT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT_TAX\"`, `\"INVOICEABLE_ONE_OFF_CREDIT\"`, `\"INVOICEABLE_ONE_OFF_CREDIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT_TAX\"`, `\"ORDER_AMOUNT\"`, `\"ORDER_AMOUNT_TAX\"`, `\"ORDER_SHIPPING_AMOUNT\"`, `\"ORDER_SHIPPING_AMOUNT_TAX\"`, `\"COMMISSION_FEE\"`, `\"COMMISSION_VAT\"`, `\"REFUND_ORDER_AMOUNT\"`, `\"REFUND_ORDER_AMOUNT_TAX\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_COMMISSION_FEE\"`, `\"REFUND_COMMISSION_VAT\"`, `\"SUBSCRIPTION_FEE\"`, `\"SUBSCRIPTION_VAT\"`, `\"OPERATOR_REMITTED_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"PAYMENT\"`, `\"PURCHASE_COMMISSION_FEE\"`, `\"PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"PURCHASE_ORDER_AMOUNT_TAX\"`, `\"PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_ORDER_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_ORDER_FEE_AMOUNT\"`, `\"REFUND_ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_FEE_AMOUNT\"`, `\"PURCHASE_FEE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_FEE_COMMISSION_FEE\"`, `\"RESERVE_FUNDING\"`, `\"RESERVE_SETTLEMENT\"`, `\"SELLER_FEE_ON_ORDER\"`, `\"SELLER_FEE_ON_ORDER_TAX\"`, `\"SELLER_PENALTY_FEE\"`, `\"SELLER_PENALTY_FEE_TAX\"`\n" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Channel", "description": "A node containing channel information" }, "debit": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee", "description": "A node containing seller additional fee information if any" }, "manual_accounting_document": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_ManualAccountingDocument", "description": "A node containing manual accounting document information if any" }, "one_off_item": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OneOffItem", "description": "A node containing invoiceable one-off item information if any" }, "order": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Order", "description": "A node containing order information if any" }, "order_fee": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderFee", "description": "A node containing order fee information if any" }, "order_line": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderLine", "description": "A node containing order line information if any" }, "order_tax": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderTax", "description": "A node containing order tax information if any" }, "refund": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Refund", "description": "A node containing refund information if any" }, "shipment": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Shipment", "description": "A node containing shipment information if any" }, "shop_tax": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_ShopTax", "description": "A node containing shop tax information if any" }, "transaction_info": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_TransactionInfo", "description": "A node containing transaction information if any" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Channel": { "type": "object", "properties": { "code": { "type": "string", "description": "The channel code" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Debit": { "type": "object", "properties": { "id": { "type": "string", "description": "The debit id" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee": { "type": "object", "properties": { "cancelations": { "type": "array", "description": "The list of cancelations information if any", "items": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee_Refunds" } } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee_Cancelations": { "type": "object", "properties": { "id": { "type": "string", "description": "The Cancelation id if the transaction log is relative to a cancelation" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee_Refunds": { "type": "object", "properties": { "id": { "type": "string", "description": "The refund id if the transaction log is relative to a refund" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_ManualAccountingDocument": { "type": "object", "properties": { "emission_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "The manual accounting document emission date." }, "number": { "type": "string", "description": "The manual accounting document number." } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OneOffItem_References" } }, "unit_price": { "type": "number", "format": "with decimals", "description": "The unit price of the invoiceable one-off item" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OneOffItem_References": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the reference" }, "value": { "type": "string", "description": "The value of the reference" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Order_PaymentInfo", "description": "A node containing payment information" }, "references": { "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Order_References", "description": "A node containing order references" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderFee": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the transaction log fee" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderLine": { "type": "object", "properties": { "id": { "type": "string", "description": "The order line id" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderTax": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the transaction log tax" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_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." } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Refund": { "type": "object", "properties": { "id": { "type": "string", "description": "The refund id if the transaction log is relative to a refund" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Shipment": { "type": "object", "properties": { "id": { "type": "string", "description": "The shipment id if the transaction log is relative to a shipment" } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_ShopTax": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the shop tax applied.
    Nb: This field will be set for line of type COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT" }, "rate": { "type": "number", "format": "with decimals", "description": "Shop tax rate applied
    Nb: This field will be set for line of type COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT
    For backward-compatibility reason, this field will be filled for lines of type COMMISSION_FEE with the rate of the first taxapplied to the shop. In this case, the value should be ignored." } } }, "TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_TransactionInfo": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The transaction date." }, "number": { "type": "string", "description": "Transaction number" } } }, "TL05_Response_200_Ext_FileStructure": { "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", "format": "with decimals", "description": "The amount." }, "amount_credited": { "type": "number", "format": "with decimals", "description": "The amount credited." }, "amount_debited": { "type": "number", "format": "with decimals", "description": "The amount debited." }, "balance": { "type": "number", "format": "with decimals", "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/TL05_Response_200_Ext_FileStructure_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.\n\nEnum: `\"NOT_SPECIFIED\"`, `\"MANGOPAY\"`, `\"MIRAKL_PAYOUT\"`, `\"OPERATOR\"`\n" }, "payment_state": { "type": "string", "description": "The payment state of the transaction.\n\nEnum: `\"PENDING\"`, `\"PAYABLE\"`, `\"PAID\"`, `\"NOT_APPLICABLE\"`, `\"RESERVE\"`\n" }, "psp_balance": { "type": "number", "format": "with decimals", "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 ...)\n\nEnum: `\"MANUAL_CREDIT\"`, `\"MANUAL_CREDIT_VAT\"`, `\"MANUAL_INVOICE\"`, `\"MANUAL_INVOICE_VAT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT\"`, `\"INVOICEABLE_ONE_OFF_DEBIT_TAX\"`, `\"INVOICEABLE_ONE_OFF_CREDIT\"`, `\"INVOICEABLE_ONE_OFF_CREDIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT\"`, `\"INVOICEABLE_MIRAKL_ADS_DEBIT_TAX\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT\"`, `\"INVOICEABLE_MIRAKL_ADS_CREDIT_TAX\"`, `\"ORDER_AMOUNT\"`, `\"ORDER_AMOUNT_TAX\"`, `\"ORDER_SHIPPING_AMOUNT\"`, `\"ORDER_SHIPPING_AMOUNT_TAX\"`, `\"COMMISSION_FEE\"`, `\"COMMISSION_VAT\"`, `\"REFUND_ORDER_AMOUNT\"`, `\"REFUND_ORDER_AMOUNT_TAX\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_COMMISSION_FEE\"`, `\"REFUND_COMMISSION_VAT\"`, `\"SUBSCRIPTION_FEE\"`, `\"SUBSCRIPTION_VAT\"`, `\"OPERATOR_REMITTED_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT\"`, `\"OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"PAYMENT\"`, `\"PURCHASE_COMMISSION_FEE\"`, `\"PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"PURCHASE_ORDER_AMOUNT_TAX\"`, `\"PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_SHIPPING_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_ORDER_AMOUNT_TAX\"`, `\"REFUND_PURCHASE_ORDER_SHIPPING_AMOUNT_TAX\"`, `\"ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_ORDER_FEE_AMOUNT\"`, `\"REFUND_ORDER_FEE_AMOUNT\"`, `\"OPERATOR_REMITTED_REFUND_ORDER_FEE_AMOUNT\"`, `\"PURCHASE_FEE_COMMISSION_FEE\"`, `\"REFUND_PURCHASE_FEE_COMMISSION_FEE\"`, `\"RESERVE_FUNDING\"`, `\"RESERVE_SETTLEMENT\"`, `\"SELLER_FEE_ON_ORDER\"`, `\"SELLER_FEE_ON_ORDER_TAX\"`, `\"SELLER_PENALTY_FEE\"`, `\"SELLER_PENALTY_FEE_TAX\"`\n" } } }, "TL05_Response_200_Ext_FileStructure_Entities": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_Channel", "description": "A node containing channel information" }, "debit": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_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/TL05_Response_200_Ext_FileStructure_Entities_Fee", "description": "A node containing seller additional fee information if any" }, "manual_accounting_document": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_ManualAccountingDocument", "description": "A node containing manual accounting document information if any" }, "one_off_item": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_OneOffItem", "description": "A node containing invoiceable one-off item information if any" }, "order": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_Order", "description": "A node containing order information if any" }, "order_fee": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_OrderFee", "description": "A node containing order fee information if any" }, "order_line": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_OrderLine", "description": "A node containing order line information if any" }, "order_tax": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_OrderTax", "description": "A node containing order tax information if any" }, "refund": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_Refund", "description": "A node containing refund information if any" }, "shipment": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_Shipment", "description": "A node containing shipment information if any" }, "shop_tax": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_ShopTax", "description": "A node containing shop tax information if any" }, "transaction_info": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_TransactionInfo", "description": "A node containing transaction information if any" } } }, "TL05_Response_200_Ext_FileStructure_Entities_Channel": { "type": "object", "properties": { "code": { "type": "string", "description": "The channel code" } } }, "TL05_Response_200_Ext_FileStructure_Entities_Debit": { "type": "object", "properties": { "id": { "type": "string", "description": "The debit id" } } }, "TL05_Response_200_Ext_FileStructure_Entities_Fee": { "type": "object", "properties": { "cancelations": { "type": "array", "description": "The list of cancelations information if any", "items": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_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/TL05_Response_200_Ext_FileStructure_Entities_Fee_Refunds" } } } }, "TL05_Response_200_Ext_FileStructure_Entities_Fee_Cancelations": { "type": "object", "properties": { "id": { "type": "string", "description": "The Cancelation id if the transaction log is relative to a cancelation" } } }, "TL05_Response_200_Ext_FileStructure_Entities_Fee_Refunds": { "type": "object", "properties": { "id": { "type": "string", "description": "The refund id if the transaction log is relative to a refund" } } }, "TL05_Response_200_Ext_FileStructure_Entities_ManualAccountingDocument": { "type": "object", "properties": { "emission_date": { "type": "string", "format": "date-time", "deprecated": true, "description": "The manual accounting document emission date." }, "number": { "type": "string", "description": "The manual accounting document number." } } }, "TL05_Response_200_Ext_FileStructure_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/TL05_Response_200_Ext_FileStructure_Entities_OneOffItem_References" } }, "unit_price": { "type": "number", "format": "with decimals", "description": "The unit price of the invoiceable one-off item" } } }, "TL05_Response_200_Ext_FileStructure_Entities_OneOffItem_References": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of the reference" }, "value": { "type": "string", "description": "The value of the reference" } } }, "TL05_Response_200_Ext_FileStructure_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/TL05_Response_200_Ext_FileStructure_Entities_Order_PaymentInfo", "description": "A node containing payment information" }, "references": { "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure_Entities_Order_References", "description": "A node containing order references" } } }, "TL05_Response_200_Ext_FileStructure_Entities_OrderFee": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the transaction log fee" } } }, "TL05_Response_200_Ext_FileStructure_Entities_OrderLine": { "type": "object", "properties": { "id": { "type": "string", "description": "The order line id" } } }, "TL05_Response_200_Ext_FileStructure_Entities_OrderTax": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the transaction log tax" }, "rate": { "type": "number", "format": "with decimals", "description": "Tax rate" } } }, "TL05_Response_200_Ext_FileStructure_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" } } }, "TL05_Response_200_Ext_FileStructure_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." } } }, "TL05_Response_200_Ext_FileStructure_Entities_Refund": { "type": "object", "properties": { "id": { "type": "string", "description": "The refund id if the transaction log is relative to a refund" } } }, "TL05_Response_200_Ext_FileStructure_Entities_Shipment": { "type": "object", "properties": { "id": { "type": "string", "description": "The shipment id if the transaction log is relative to a shipment" } } }, "TL05_Response_200_Ext_FileStructure_Entities_ShopTax": { "type": "object", "properties": { "code": { "type": "string", "description": "The code of the shop tax applied.
    Nb: This field will be set for line of type COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT" }, "rate": { "type": "number", "format": "with decimals", "description": "Shop tax rate applied
    Nb: This field will be set for line of type COMMISSION_VAT, MANUAL_CREDIT_VAT, MANUAL_INVOICE_VAT, REFUND_COMMISSION_VAT, SUBSCRIPTION_VAT
    For backward-compatibility reason, this field will be filled for lines of type COMMISSION_FEE with the rate of the first taxapplied to the shop. In this case, the value should be ignored." } } }, "TL05_Response_200_Ext_FileStructure_Entities_TransactionInfo": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The transaction date." }, "number": { "type": "string", "description": "Transaction number" } } }, "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" } } }, "required": [ "code", "label_translations" ] }, "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" } } }, "required": [ "code", "label_translations" ] }, "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", "x-authorization": "{{SHOP_KEY}}" } } }, "info": { "description": "{% partial file=\"/partial-content/product/mmp/rest/seller/openapi-description.md\" /%}", "title": "Mirakl Marketplace APIs", "version": "" }, "openapi": "3.1.0", "paths": { "/api/account": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "applicable_taxes": [ { "code": "TAXDEFAULT", "fee_types": [ "COMMISSION", "SUBSCRIPTION", "ADDITIONAL_FEES" ], "label": "ShopTax.TAXDEFAULT.label" } ], "approval_delay": 33, "approval_rate": 1, "banner": "https://url.mirakl.net/mmp/media/shop-banner/2000", "channels": [ "US" ], "closed_from": "2019-07-31T22:00:00Z", "closed_to": "2019-08-31T21:59:59Z", "contact_informations": { "city": "New York", "civility": "Mr", "country": "USA", "email": "shop@mail.com", "fax": "213-509-6997", "firstname": "John", "lastname": "Doe", "phone": "213-509-6995", "phone_secondary": "213-509-6996", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "web_site": "https://www.mirakl.com", "zip_code": "NY 10012" }, "currency_iso_code": "USD", "date_created": "2019-03-25T14:34:03Z", "default_billing_information": { "corporate_information": { "company_registration_name": "ACME SHOP", "company_registration_number": "01234567" }, "default_language": "en_US", "fiscal_information": { "tax_identification_country": "USA", "tax_identification_number": "XXX-XX-XXXX" }, "id": "a83c1170-f8cb-45a1-aa4a-affe809d6c64", "registration_address": { "city": "New York", "country_iso_code": "USA", "state": "New York", "street_1": "30, Prince Street", "street_2": null, "zip_code": "NY 10012" } }, "description": "Games seller", "domains": [ "PRODUCT" ], "evaluations_count": 3, "free_shipping": false, "grade": 4, "is_professional": true, "kyc": { "reason": "Missing information", "status": "REFUSED" }, "last_updated_date": "2019-03-28T09:28:59Z", "logo": "https://url.mirakl.net/mmp/media/shop-logo/2000", "model": "MARKETPLACE", "offers_count": 234, "order_messages_response_delay": 76, "orders_count": 7, "payment_details": { "paid_balance": -170.06, "payable_balance": -259.2, "pending_balance": 512.84, "reserve_balance": 0, "reserve_target": 0, "sub_balances": [ { "paid": -170.06, "pay_out_psp_code": "NOT_SPECIFIED", "payable": -259.2, "pending": 512.84 } ] }, "payment_info": { "@type": "ABA", "bank_account_number": "000123456789123", "bank_city": "New York", "bank_name": "Bank of America", "bank_street": "115 W 42nd St", "bank_zip": "NY 10036 US", "bic": "BOFAUS3NXXX", "owner": "John Doe", "routing_number": "789456124" }, "payment_method_mandatory": true, "premium": true, "pro_details": { "corporate_name": "ACME SHOP", "identification_number": "01234567", "tax_identification_number": "XXX-XX-XXXX" }, "producer_identifiers": [ { "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "epr_category_code": "DE-WEEE", "producer_id": "PRODUCERID1" } ], "recycling_policy": "When we deliver your new item, we’ll take your old one away for you. Appliance recycling: this service is available through our home delivery service. Recycling electronic items in-store: if you have an old electronic item, we can safely recycle these items in-store, for free", "return_policy": "Any product return must be the subject of a formal agreement between the Seller and Purchaser. Any product returned without this agreement shall be held on behalf of the Purchaser and shall not give rise to the granting of any credit note. Claims must be received by shop within 8 days of the delivery of the goods. Subsequently to this delay, no claims shall be accepted. Once this delay has expired, should the client not have addressed their claim in writing to shop, the client is deemed to have accepted the product.\r\nWarranties that cover the delivered goods only apply within the framework of their intended use. Defects and damage resulting from natural wear, faulty assembly or maintenance, as well as modification of the products that was not intended or specified by the Seller are excluded from the warranty. Goods must be returned in their original packaging and as new, the cost and risks of returning the goods being borne by the Purchaser. Once the returned goods have been received and inspected, shop shall send the Purchaser a credit note corresponding to the amount of the original invoice, after deduction of any compensation or expenses which arise from any reconditioning work deemed necessary. This sum is credited to the account that the Purchaser has opened with the shop.", "shipping": { "lead_time_to_ship": 2 }, "shipping_country": "USA", "shippings": [ { "additional_fields": [ { "code": "productid", "type": "STRING", "value": "EAN123456789" } ], "shipping_free_amount": 550, "shipping_type_code": "EXP", "shipping_type_label": "Express", "shipping_type_standard_code": "CU_ADD-EXP", "shipping_zone_code": "DOM2", "shipping_zone_label": "Domestic 2" }, { "additional_fields": [ { "code": "osi", "type": "STRING", "value": "5 articles per box" } ], "shipping_free_amount": 550, "shipping_type_code": "EXP", "shipping_type_label": "Express", "shipping_type_standard_code": "CU_ADD-EXP", "shipping_zone_code": "INT1", "shipping_zone_label": "International 1" }, { "additional_fields": [ { "code": "osi", "type": "STRING", "value": "One article per box " }, { "code": "osi1", "type": "STRING", "value": "Five articles per box" }, { "code": "productid", "type": "STRING", "value": "EAN12345678" } ], "shipping_free_amount": 570, "shipping_type_code": "STD", "shipping_type_label": "Standard", "shipping_type_standard_code": "CU_ADD-STD", "shipping_zone_code": "DOM1", "shipping_zone_label": "Domestic 1" } ], "shop_additional_fields": [ { "code": "accounting-phone", "type": "STRING", "value": "213-509-6995" }, { "code": "customer-care-phone", "type": "STRING", "value": "213-509-6996" }, { "code": "recruitment", "type": "LIST", "value": "Opt-In" } ], "shop_id": 2000, "shop_name": "ACME SHOP", "shop_state": "OPEN", "suspension_type": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "applicable_taxes": [ { "code": "string", "fee_types": [ "COMMISSION" ], "label": "string" } ], "approval_delay": 0, "approval_rate": 0, "banner": "string", "billing_info": { "bank_city": "string", "bank_name": "string", "bank_street": "string", "bic": "string", "iban": "string", "owner": "string", "zip_code": "string" }, "channels": [ "string" ], "closed_from": "2023-03-28T09:34:42Z", "closed_to": "2023-03-28T09:34:42Z", "contact_informations": { "city": "string", "civility": "string", "country": "string", "email": "string", "fax": "string", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "web_site": "string", "zip_code": "string" }, "currency_iso_code": "AED", "date_created": "2023-03-28T09:34:42Z", "default_billing_information": { "corporate_information": { "company_registration_name": "string", "company_registration_number": "string", "complementary_information": { "business_activity_code": "string", "company_registration_city": "string", "company_registration_province": "string", "company_shareholders": "SINGLE", "is_in_liquidation": true, "legal_form": "string", "share_capital": 0, "share_capital_currency": "AED", "sole_trader": true }, "electronic_address": "string", "phone_number": "string" }, "default_language": "string", "fiscal_information": { "local_tax_number": "string", "tax_identification_country": "AFG", "tax_identification_number": "string" }, "fiscal_representative": { "city": "string", "civility": "string", "company_registration_name": "string", "company_registration_number": "string", "country_iso_code": "AFG", "first_name": "string", "last_name": "string", "local_tax_number": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "id": "string", "personal_information": { "birth_city": "string", "birth_country": "AFG", "birth_date": "string", "civility": "string", "first_name": "string", "last_name": "string" }, "registration_address": { "city": "string", "country_iso_code": "AFG", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } }, "description": "string", "domains": [ "PRODUCT" ], "dropship": { "retail_pricing_edition_enabled": true }, "evaluations_count": 0, "free_shipping": true, "grade": 0, "is_professional": true, "kyc": { "reason": "string", "status": "PENDING_SUBMISSION" }, "last_updated_date": "2023-03-28T09:34:42Z", "logo": "string", "model": "MARKETPLACE", "offers_count": 0, "order_messages_response_delay": 0, "orders_count": 0, "payment_details": { "paid_balance": 0, "payable_balance": 0, "pending_balance": 0, "reserve_balance": 0, "reserve_target": 0, "sub_balances": [ { "paid": 0, "pay_out_psp_code": "NOT_SPECIFIED", "payable": 0, "pending": 0 } ] }, "payment_info": { "@type": "IBAN", "owner": "string" }, "payment_method_mandatory": true, "premium": true, "pro_details": { "VAT_number": "string", "corporate_name": "string", "identification_number": "string", "tax_identification_number": "string" }, "producer_identifiers": [ { "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "recycling_policy": "string", "return_policy": "string", "shipping": { "lead_time_to_ship": 0 }, "shipping_country": "string", "shipping_types": [ "string" ], "shipping_zones": [ "string" ], "shippings": [ { "additional_fields": [ { "code": "string", "type": "STRING" } ], "shipping_free_amount": 0, "shipping_type_code": "string", "shipping_type_label": "string", "shipping_type_standard_code": "string", "shipping_zone_code": "string", "shipping_zone_label": "string" } ], "shop_additional_fields": [ { "code": "string", "type": "STRING" } ], "shop_id": 0, "shop_name": "string", "shop_state": "OPEN", "specific_billing_informations": [ { "corporate_information": { "company_registration_name": "string", "company_registration_number": "string", "complementary_information": { "business_activity_code": "string", "company_registration_city": "string", "company_registration_province": "string", "company_shareholders": "SINGLE", "is_in_liquidation": true, "legal_form": "string", "share_capital": 0, "share_capital_currency": "AED", "sole_trader": true }, "electronic_address": "string", "phone_number": "string" }, "fiscal_information": { "local_tax_number": "string", "tax_identification_country": "AFG", "tax_identification_number": "string" }, "fiscal_representative": { "city": "string", "civility": "string", "company_registration_name": "string", "company_registration_number": "string", "country_iso_code": "AFG", "first_name": "string", "last_name": "string", "local_tax_number": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "id": "string", "personal_information": { "birth_city": "string", "birth_country": "AFG", "birth_date": "string", "civility": "string", "first_name": "string", "last_name": "string" }, "registration_address": { "city": "string", "country_iso_code": "AFG", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } } ], "suspension_type": "MANUAL" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/A01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_READ" ] } ], "summary": "A01 - Get shop information", "tags": [ "Stores" ] }, "put": { "description": "
    Description
    \n\nDepending on the operator's configuration, some fields might not be editable.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each information update
    \n
    Maximum usage: Once per day
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Update shop account", "value": { "address": { "city": "New York", "civility": "Mr", "country": "USA", "firstname": "Doe", "lastname": "John", "phone": "213-509-6996", "phone_secondary": "213-509-6995", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "channels": [ "US" ], "closed_from": "2025-03-20T16:42:21Z", "closed_to": "2026-03-20T16:42:21Z", "description": "This is the description of this seller", "email": "my-store@example.com", "fax": "0245875499", "is_professional": true, "payment_info": { "@type": "IBAN", "bank_name": "CACE", "bic": "AGRIFRPPXX2", "iban": "FR6031047696713027315572590", "owner": "John Doe" }, "pro_details": { "corporate_name": "Mirakl Inc.", "identification_number": "44268625900078", "tax_identification_number": "FR939383" }, "producer_identifiers": [ { "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "epr_category_code": "DE-WEEE", "producer_id": "PRODUCERID1" } ], "recycling_policy": "When we deliver your new item,we’ll take your old one away for you.Appliance recycling:this service is available through our home delivery service.Recycling electronic items in-store:if you have an old electronic item,we can safely recycle these items in-store,for free", "return_policy": "3 days return policy", "shipping_country": "ITA", "shop_additional_fields": [ { "code": "segment", "value": "1" }, { "code": "prio-level", "value": "High" } ], "shop_name": "My Super Seller", "web_site": "https://example.fr" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "address": { "city": "string", "civility": "string", "country": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" }, "channels": [ "string" ], "closed_from": "2023-03-28T09:34:42Z", "closed_to": "2023-03-28T09:34:42Z", "description": "string", "email": "string", "fax": "string", "is_professional": true, "payment_info": { "@type": "IBAN", "owner": "string" }, "pro_details": { "corporate_name": "string", "identification_number": "string", "tax_identification_number": "string" }, "producer_identifiers": [ { "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "recycling_policy": "string", "return_policy": "string", "shipping_country": "AFG", "shop_additional_fields": [ { "code": "string", "type": "STRING" } ], "shop_name": "string", "web_site": "string" } } }, "schema": { "$ref": "#/components/schemas/A02_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Response to a shop account update", "value": { "errors": [], "updated": { "address": { "city": "New York", "civility": "Mr", "country": "USA", "firstname": "Doe", "lastname": "John", "phone": "213-509-6996", "phone_secondary": "213-509-6995", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "channels": [ "US" ], "closed_from": "2022-03-20T16:42:21Z", "closed_to": "2025-03-20T16:42:21Z", "default_billing_information": { "corporate_information": { "company_registration_name": "Mirakl Inc.", "company_registration_number": "44268625900078" }, "default_language": "en_US", "fiscal_information": { "tax_identification_country": "FR", "tax_identification_number": "FR939383" }, "id": "a83c1170-f8cb-45a1-aa4a-affe809d6c64", "registration_address": { "city": "Paris", "country_iso_code": "FRA", "state": null, "street_1": "1 avenue Victor Hugo", "street_2": null, "zip_code": "75016" } }, "description": "This is the description of this seller", "email": "my-store@example.com", "fax": "0245875499", "is_professional": true, "model": "MARKETPLACE", "payment_info": { "@type": "IBAN", "bank_name": "CACE", "bic": "AGRIFRPPXX2", "iban": "FR6031047696713027315572590", "owner": "John Doe" }, "payment_method_mandatory": true, "pro_details": { "corporate_name": "Mirakl Inc.", "identification_number": "44268625900078", "tax_identification_number": "FR939383" }, "producer_identifiers": [ { "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "epr_category_code": "DE-WEEE", "producer_id": "PRODUCERID1" } ], "recycling_policy": "When we deliver your new item,we’ll take your old one away for you.Appliance recycling:this service is available through our home delivery service.Recycling electronic items in-store:if you have an old electronic item,we can safely recycle these items in-store,for free", "return_policy": "3 days return policy", "shipping": { "lead_time_to_ship": 2 }, "shipping_country": "ITA", "shop_additional_fields": [ { "code": "segment", "type": "STRING", "value": "1" }, { "code": "prio-level", "type": "STRING", "value": "High" } ], "shop_name": "My Super Seller", "web_site": "https://example.fr" } } }, "application/json-1": { "summary": "Example of a response with errors", "value": { "errors": [ { "code": "shop.identification_number_cannot_be_updated_by_this_user", "field": "shop_pro_detail.identification_number", "message": "You are not allowed to update the identification number. Please contact your operator." }, { "code": "shop.tax_number_cannot_be_updated_by_this_user", "field": "shop_pro_detail.tax_identification_number", "message": "You are not allowed to update the tax number. Please contact your operator." } ], "updated": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "updated": { "address": { "city": "string", "civility": "string", "country": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" }, "channels": [ "string" ], "closed_from": "2023-03-28T09:34:42Z", "closed_to": "2023-03-28T09:34:42Z", "default_billing_information": { "corporate_information": { "company_registration_name": "string", "company_registration_number": "string", "complementary_information": { "business_activity_code": "string", "company_registration_city": "string", "company_registration_province": "string", "company_shareholders": "SINGLE", "is_in_liquidation": true, "legal_form": "string", "share_capital": 0, "share_capital_currency": "AED", "sole_trader": true }, "electronic_address": "string", "phone_number": "string" }, "default_language": "string", "fiscal_information": { "local_tax_number": "string", "tax_identification_country": "AFG", "tax_identification_number": "string" }, "fiscal_representative": { "city": "string", "civility": "string", "company_registration_name": "string", "company_registration_number": "string", "country_iso_code": "AFG", "first_name": "string", "last_name": "string", "local_tax_number": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "id": "string", "personal_information": { "birth_city": "string", "birth_country": "AFG", "birth_date": "string", "civility": "string", "first_name": "string", "last_name": "string" }, "registration_address": { "city": "string", "country_iso_code": "AFG", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } }, "description": "string", "email": "string", "fax": "string", "is_professional": true, "model": "MARKETPLACE", "payment_info": { "@type": "IBAN", "owner": "string" }, "payment_method_mandatory": true, "pro_details": { "corporate_name": "string", "identification_number": "string", "tax_identification_number": "string" }, "producer_identifiers": [ { "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "recycling_policy": "string", "return_policy": "string", "shipping": { "lead_time_to_ship": 0 }, "shipping_country": "AFG", "shop_additional_fields": [ { "code": "string", "type": "STRING" } ], "shop_name": "string", "specific_billing_informations": [ { "corporate_information": { "company_registration_name": "string", "company_registration_number": "string", "complementary_information": { "business_activity_code": "string", "company_registration_city": "string", "company_registration_province": "string", "company_shareholders": "SINGLE", "is_in_liquidation": true, "legal_form": "string", "share_capital": 0, "share_capital_currency": "AED", "sole_trader": true }, "electronic_address": "string", "phone_number": "string" }, "fiscal_information": { "local_tax_number": "string", "tax_identification_country": "AFG", "tax_identification_number": "string" }, "fiscal_representative": { "city": "string", "civility": "string", "company_registration_name": "string", "company_registration_number": "string", "country_iso_code": "AFG", "first_name": "string", "last_name": "string", "local_tax_number": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "id": "string", "personal_information": { "birth_city": "string", "birth_country": "AFG", "birth_date": "string", "civility": "string", "first_name": "string", "last_name": "string" }, "registration_address": { "city": "string", "country_iso_code": "AFG", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } } ], "web_site": "string" } } } }, "schema": { "type": "object", "$ref": "#/components/schemas/A02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_UPDATE" ] } ], "summary": "A02 - Update shop information", "tags": [ "Stores" ] } }, "/api/account/statistics": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    ", "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "approval_delay": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "approval_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "auto_refused_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "average_cart": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "average_cart_with_shipping": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "cancelation_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "channel": "string", "consecutive_refused_orders_count": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "evaluations_count": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "grade": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "incident_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "last_updated_date": "2023-03-28T09:34:42Z", "late_shipment_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "offers_count": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "order_messages_response_delay": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "orders_count": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "refund_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "return_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "shipping_delay": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "shop_id": 0, "total_revenue": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ], "valid_tracking_rate": [ { "period": "ALL_SINCE_BEGINNING", "value": 0 } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/A21_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_READ" ] } ], "summary": "A21 - Get shop statistics", "tags": [ "Stores" ] } }, "/api/additional_fields": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "additional_fields": [ { "code": "ecotax", "description": "The amount of the price to be collected as Eco tax.", "editable": true, "entity": "OFFER", "label": "Eco tax", "required": false, "type": "NUMERIC" }, { "code": "gift-message", "description": "Message to send with the order.", "editable": true, "entity": "ORDER_LINE", "label": "Gift Message", "required": false, "type": "STRING" }, { "code": "customer-care-phone", "description": "Phone number to contact customer care service.", "editable": true, "entity": "SHOP", "label": "Customer care phone number", "required": false, "type": "STRING" }, { "code": "accounting-phone", "description": "Phone number to contact accounting service.", "editable": false, "entity": "SHOP", "label": "Accounting phone number", "required": false, "type": "STRING" }, { "accepted_values": [ "Opt-In", "Headhunted", "Contact-Form" ], "code": "recruitment", "description": "How the shop has been recruited on the platform.", "editable": true, "entity": "SHOP", "label": "Recruitment Method", "required": false, "type": "LIST" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "additional_fields": [ { "accepted_values": [ "string" ], "code": "string", "default_value": "string", "description": "string", "editable": true, "entity": "SHOP", "label": "string", "personal_data": true, "regex": "string", "required": true, "type": "STRING" } ], "total_count": 0 } } }, "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": "AF01 - List all custom fields", "tags": [ "Platform Settings" ] } }, "/api/channels": { "get": { "description": "
    Description
    \n\nResults are sorted by code\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "channels": [ { "code": "BFR", "description": "Black Friday", "label": "Black Friday" }, { "code": "CA", "description": "Website CA", "label": "Website CA" }, { "code": "CHR", "description": "Christmas", "label": "Christmas" }, { "code": "FR", "description": "Website FR", "label": "Website FR" }, { "code": "US", "description": "Website US", "label": "Website US" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "channels": [ { "code": "string", "description": "string", "label": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/CH11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CHANNEL_READ" ] } ], "summary": "CH11 - List all enabled channels", "tags": [ "Platform Settings" ] } }, "/api/currencies": { "get": { "description": "
    Description
    \n\nList currency codes and labels activated on the platform\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "currencies": [ { "code": "EUR", "label": "Euro", "platform_default": true }, { "code": "JPY", "label": "Japanese Yen" }, { "code": "USD", "label": "US Dollar" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "currencies": [ { "code": "string", "label": "string", "platform_default": true } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/CUR01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CURRENCY_SETTINGS_READ" ] } ], "summary": "CUR01 - List currency codes and labels", "tags": [ "Platform Settings" ] } }, "/api/documents": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "documents": [ { "code": "SYSTEM_DELIVERY_BILL", "description": "Delivery slip", "entity": "ORDER", "label": "Delivery slip" }, { "code": "CUSTOMER_INVOICE", "description": "Invoice", "entity": "ORDER", "label": "Invoice" }, { "code": "LEGAL_DOC", "description": "Legal documents", "entity": "SHOP", "label": "Legal documents" }, { "code": "ID_CARD", "description": "General Manager ID card", "entity": "SHOP", "label": "General Manager ID card" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "documents": [ { "code": "string", "description": "string", "entity": "ORDER", "label": "string", "mime_types": [ "string" ] } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/DO01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ" ] } ], "summary": "DO01 - List all document types", "tags": [ "Platform Settings" ] } }, "/api/document-request/requests": { "get": { "description": "
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (desc by default)
    \n\n
    ", "operationId": "DR11", "parameters": [ { "description": "Filter by accounting document request identifier.", "explode": true, "in": "query", "name": "id", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter by accounting document number.", "explode": true, "in": "query", "name": "document_number", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter accounting document requests created after the given date.", "explode": true, "in": "query", "name": "date_created_from", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "STAGING", "TO_PROCESS", "ISSUED", "CANCELED" ] }, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "INVOICE", "CREDIT_NOTE" ] }, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "OPERATOR", "SHOP" ] }, "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", "required": false, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PRODUCT_LOGISTIC_ORDER", "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "LOGISTIC_PURCHASE_ORDER", "FEES", "ONE_OFF_FEES" ] }, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "string", "enum": [ "PAID", "PENDING" ] }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "List all document requests", "value": { "data": [ { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "ship_to_iso_country_code": "FRA", "shop_billing_cycle": { "date_from": "2024-01-01T08:00:01Z", "date_to": "2024-01-01T08:00:01Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "id": "f8a553c6-0adc-4544-bed8-736221272f2a", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 1300 } ], "total_amount_excluding_taxes": 6500, "total_amount_including_taxes": 7800, "total_tax_amount": 1300, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entities": { "shop_billing_cycle": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES", "id": "f1a2b3c4-5678-9abc-def0-112233445588", "initial_documents": [ { "id": "38a9d7a2-3418-11f1-9541-abc065fa90d8", "issue_date": "2025-06-02T00:00:00Z", "type": "INVOICE" } ], "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 12 } ], "total_amount_excluding_taxes": 60, "total_amount_including_taxes": 72, "total_tax_amount": 12, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "shipping_information": { "ship_to_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "123123123-A", "entity_type": "LOGISTIC_PURCHASE_ORDER", "id": "f12e02f4-3421-11f1-8710-8ba3659d2900", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "ship_to_iso_country_code": "FRA", "shop_billing_cycle": { "date_from": "2024-01-01T08:00:01Z", "date_to": "2024-01-01T08:00:01Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "id": "c4a7e1b2-5d39-4f8a-b123-9876abcdef01", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 300 } ], "total_amount_excluding_taxes": 1500, "total_amount_including_taxes": 1800, "total_tax_amount": 300, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "c3d4e5f6-3430-11f1-b71b-eb1d36ddc383", "entity_type": "ONE_OFF_FEES", "id": "c3d4e5f6-3430-11f1-b71b-eb1d36ddc383", "initial_documents": [ { "id": "be4efb5a-342f-11f1-b71b-eb1d36ddc382", "issue_date": "2025-06-02T00:00:00Z", "type": "INVOICE" } ], "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 12 } ], "total_amount_excluding_taxes": 60, "total_amount_including_taxes": 72, "total_tax_amount": 12, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "be4efb5a-342f-11f1-b71b-eb1d36ddc382", "entity_type": "ONE_OFF_FEES", "id": "be4efb5a-342f-11f1-b71b-eb1d36ddc382", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "document_number": "IN1234A-1", "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "1234567890-A", "entity_type": "PRODUCT_LOGISTIC_ORDER", "id": "bdf76a80-216d-441d-b650-7736076015d0", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_destination": { "@type": "IBAN", "iban": "FR7630001007941234567890185", "payment_reference": "REF-A1654" }, "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Noisy-le-grand", "civility": "MRS", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "street_1": "48 boulevard de Prague", "street_2": "Bâtiment 2", "zip_code": "93160" }, "id": "62697a48-3413-11f1-bfc1-5f49c5e88baf", "locale": "fr_FR", "shipping_address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" } }, "state": "ISSUED", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "shipping_information": { "ship_to_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "123123123-A", "entity_type": "LOGISTIC_PURCHASE_ORDER", "id": "a23b4c5d-6789-4def-a012-345678abcdef", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 6 } ], "total_amount_excluding_taxes": 30, "total_amount_including_taxes": 36, "total_tax_amount": 6, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "9876543210-A", "entity_type": "PRODUCT_LOGISTIC_ORDER", "id": "681ab1e8-5e70-49b6-9489-36e766d64328", "initial_documents": [ { "id": "bdf76a80-216d-441d-b650-7736076015d0", "issue_date": "2025-06-02T00:00:00Z", "number": "IN1234A-1", "type": "INVOICE" } ], "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Noisy-le-grand", "civility": "MRS", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "street_1": "48 boulevard de Prague", "street_2": "Bâtiment 2", "zip_code": "93160" }, "id": "62697a48-3413-11f1-bfc1-5f49c5e88baf", "locale": "fr_FR", "shipping_address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" } }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 14 } ], "total_amount_excluding_taxes": 70, "total_amount_including_taxes": 84, "total_tax_amount": 14, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entities": { "shop_billing_cycle": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES", "id": "38a9d7a2-3418-11f1-9541-abc065fa90d8", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" } ] } }, "application/json-1": { "summary": "List all PRODUCT_LOGISTIC_ORDER document requests", "value": { "data": [ { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "document_number": "IN1234A-1", "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "1234567890-A", "entity_type": "PRODUCT_LOGISTIC_ORDER", "id": "bdf76a80-216d-441d-b650-7736076015d0", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_destination": { "@type": "IBAN", "iban": "FR7630001007941234567890185", "payment_reference": "REF-A1654" }, "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Noisy-le-grand", "civility": "MRS", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "street_1": "48 boulevard de Prague", "street_2": "Bâtiment 2", "zip_code": "93160" }, "id": "62697a48-3413-11f1-bfc1-5f49c5e88baf", "locale": "fr_FR", "shipping_address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" } }, "state": "ISSUED", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "9876543210-A", "entity_type": "PRODUCT_LOGISTIC_ORDER", "id": "681ab1e8-5e70-49b6-9489-36e766d64328", "initial_documents": [ { "id": "bdf76a80-216d-441d-b650-7736076015d0", "issue_date": "2025-06-02T00:00:00Z", "number": "IN1234A-1", "type": "INVOICE" } ], "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Noisy-le-grand", "civility": "MRS", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "street_1": "48 boulevard de Prague", "street_2": "Bâtiment 2", "zip_code": "93160" }, "id": "62697a48-3413-11f1-bfc1-5f49c5e88baf", "locale": "fr_FR", "shipping_address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country": "France", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" } }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 14 } ], "total_amount_excluding_taxes": 70, "total_amount_including_taxes": 84, "total_tax_amount": 14, "type": "CREDIT_NOTE" } ] } }, "application/json-2": { "summary": "List all SHOP_BILLING_CYCLE_PURCHASE_ORDER document requests", "value": { "data": [ { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "ship_to_iso_country_code": "FRA", "shop_billing_cycle": { "date_from": "2024-01-01T08:00:01Z", "date_to": "2024-01-01T08:00:01Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "id": "f8a553c6-0adc-4544-bed8-736221272f2a", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 1300 } ], "total_amount_excluding_taxes": 6500, "total_amount_including_taxes": 7800, "total_tax_amount": 1300, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "ship_to_iso_country_code": "FRA", "shop_billing_cycle": { "date_from": "2024-01-01T08:00:01Z", "date_to": "2024-01-01T08:00:01Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "id": "c4a7e1b2-5d39-4f8a-b123-9876abcdef01", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 300 } ], "total_amount_excluding_taxes": 1500, "total_amount_including_taxes": 1800, "total_tax_amount": 300, "type": "CREDIT_NOTE" } ] } }, "application/json-3": { "summary": "List all LOGISTIC_PURCHASE_ORDER document requests", "value": { "data": [ { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "shipping_information": { "ship_to_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "123123123-A", "entity_type": "LOGISTIC_PURCHASE_ORDER", "id": "f12e02f4-3421-11f1-8710-8ba3659d2900", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [ { "format": "PDF" } ], "due_date": "2025-07-02T00:00:00Z", "entities": { "shipping_information": { "ship_to_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "123123123-A", "entity_type": "LOGISTIC_PURCHASE_ORDER", "id": "a23b4c5d-6789-4def-a012-345678abcdef", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "837606d6-3416-11f1-9cb4-33f11d6a3b91", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country": "France", "country_iso_code": "FRA", "state": "Île-de-France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "organization_id": "a16f4e36-3411-11f1-803d-9342431024ae", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 6 } ], "total_amount_excluding_taxes": 30, "total_amount_including_taxes": 36, "total_tax_amount": 6, "type": "CREDIT_NOTE" } ] } }, "application/json-4": { "summary": "List all FEES document requests", "value": { "data": [ { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entities": { "shop_billing_cycle": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES", "id": "f1a2b3c4-5678-9abc-def0-112233445588", "initial_documents": [ { "id": "38a9d7a2-3418-11f1-9541-abc065fa90d8", "issue_date": "2025-06-02T00:00:00Z", "type": "INVOICE" } ], "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 12 } ], "total_amount_excluding_taxes": 60, "total_amount_including_taxes": 72, "total_tax_amount": 12, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entities": { "shop_billing_cycle": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z", "id": "df3a1eb6-3947-4102-ad4e-ef621ad66671" } }, "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES", "id": "38a9d7a2-3418-11f1-9541-abc065fa90d8", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" } ] } }, "application/json-5": { "summary": "List all ONE_OFF_FEES document requests", "value": { "data": [ { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "c3d4e5f6-3430-11f1-b71b-eb1d36ddc383", "entity_type": "ONE_OFF_FEES", "id": "c3d4e5f6-3430-11f1-b71b-eb1d36ddc383", "initial_documents": [ { "id": "be4efb5a-342f-11f1-b71b-eb1d36ddc382", "issue_date": "2025-06-02T00:00:00Z", "type": "INVOICE" } ], "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 12 } ], "total_amount_excluding_taxes": 60, "total_amount_including_taxes": 72, "total_tax_amount": 12, "type": "CREDIT_NOTE" }, { "currency_iso_code": "EUR", "date_created": "2025-06-02T00:00:00Z", "document_details": [], "due_date": "2025-07-02T00:00:00Z", "entity_date_created": "2025-06-01T00:00:00Z", "entity_id": "be4efb5a-342f-11f1-b71b-eb1d36ddc382", "entity_type": "ONE_OFF_FEES", "id": "be4efb5a-342f-11f1-b71b-eb1d36ddc382", "initial_payment_state": "NOT_PAID", "issue_date": "2025-06-02T00:00:00Z", "issuer": { "id": "59408d80-340e-11f1-a5a7-4bc65396d791", "organization": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "France", "street_1": "12, rue de Lübeck", "street_2": "Bâtiment A", "zip_code": "75116" }, "electronic_address": "0007:12345678901234", "identification_number": "53089799000079", "local_tax_number": "FR57530897990", "local_tax_number_country": "FRA", "name": "Mirakl", "phone_number": "+33172316200", "tax_identification_number": "530897990", "tax_number_country": "FRA" }, "type": "OPERATOR" }, "last_updated": "2025-06-02T00:00:00Z", "payment_terms": { "days": 30, "type": "NET" }, "recipient": { "billing_address": { "city": "Paris", "company": "Acme Marketplace", "country_iso_code": "FRA", "street_1": "46 Rue de Montmorency", "zip_code": "75003" }, "id": "9cc3020c-3415-11f1-8d4f-bf432e4e10a7", "locale": "fr_FR", "organization": { "electronic_address": "0007:12345678901234", "identification_number": "12345678912345", "local_tax_number": "FRXX123456789", "local_tax_number_country": "FRA", "name": "Acme Marketplace", "organization_id": "a3c9c9c8-3415-11f1-9e5f-5fb45bd58dcf", "phone_number": "+33172316200", "tax_identification_number": "123456789", "tax_number_country": "FRA" }, "type": "SHOP" }, "state": "TO_PROCESS", "taxes": [ { "code": "TVA", "rate": 20, "total_amount": 20 } ], "total_amount_excluding_taxes": 100, "total_amount_including_taxes": 120, "total_tax_amount": 20, "type": "INVOICE" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "currency_iso_code": "AED", "date_created": "2023-03-28T09:34:42Z", "document_details": [ { "format": "PDF" } ], "document_number": "string", "document_upload_date": "2023-03-28T09:34:42Z", "due_date": "2023-03-28T09:34:42Z", "entities": { "delivery_bill_information": [ { "delivery_bill_date": "string", "delivery_bill_id": "string" } ], "order_additional_fields": [ { "code": "string", "type": "STRING", "value": "string" } ], "ship_to_iso_country_code": "string", "shipping_information": { "ship_to_address": { "city": "string", "civility": "string", "company": "string", "company2": "string", "country_iso_code": "string", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" } }, "shop_billing_cycle": { "date_from": "2023-03-28T09:34:42Z", "date_to": "2023-03-28T09:34:42Z", "id": "string" } }, "entity_date_created": "2023-03-28T09:34:42Z", "entity_id": "string", "entity_type": "PRODUCT_LOGISTIC_ORDER", "id": "string", "initial_documents": [ { "id": "string", "issue_date": "2023-03-28T09:34:42Z", "number": "string", "type": "INVOICE" } ], "initial_payment_state": "PAID", "issue_date": "2023-03-28T09:34:42Z", "issuer": { "id": "string", "locale": "string", "organization": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "business_activity_code": "string", "company_shareholders": "string", "electronic_address": "string", "fiscal_representative": { "city": "string", "civility": "string", "company_registration_name": "string", "company_registration_number": "string", "country_iso_code": "string", "first_name": "string", "last_name": "string", "local_tax_number": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "identification_number": "string", "is_in_liquidation": true, "legal_form": "string", "local_tax_number": "string", "local_tax_number_country": "string", "name": "string", "personal_information": { "civility": "string", "first_name": "string", "last_name": "string" }, "phone_number": "string", "share_capital": 0, "share_capital_currency": "string", "sole_trader": true, "tax_identification_number": "string", "tax_number_country": "string", "trade_company_registration_location": "string" }, "type": "OPERATOR" }, "last_updated": "2023-03-28T09:34:42Z", "payment": { "reference": "string", "state": "PAID", "transaction_date": "2023-03-28T09:34:42Z" }, "payment_destination": { "@type": "IBAN", "payment_reference": "string" }, "payment_terms": { "days": 0, "type": "END_OF_MONTH" }, "recipient": { "billing_address": { "city": "string", "civility": "string", "company": "string", "company_2": "string", "country": "string", "country_iso_code": "string", "firstname": "string", "lastname": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "id": "string", "locale": "string", "organization": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "business_activity_code": "string", "company_shareholders": "string", "electronic_address": "string", "identification_number": "string", "is_in_liquidation": true, "legal_form": "string", "local_tax_number": "string", "local_tax_number_country": "string", "name": "string", "organization_id": "string", "phone_number": "string", "share_capital": 0, "share_capital_currency": "string", "tax_identification_number": "string", "tax_number_country": "string", "trade_company_registration_location": "string" }, "shipping_address": { "city": "string", "civility": "string", "company": "string", "company_2": "string", "country": "string", "country_iso_code": "string", "firstname": "string", "lastname": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "type": "CUSTOMER" }, "state": "STAGING", "taxes": [ { "code": "string", "rate": 0, "total_amount": 0 } ], "total_amount_excluding_taxes": 0, "total_amount_including_taxes": 0, "total_tax_amount": 0, "type": "INVOICE" } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/DR11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CUSTOMER_ACCOUNTING_DOCUMENT_REQUEST_READ", "ROLE_PARTNER_ACCOUNTING_DOCUMENT_READ" ] } ], "summary": "DR11 - List accounting documents requests", "tags": [ "Invoicing and Accounting" ] } }, "/api/document-request/{document_request_id}/lines": { "get": { "description": "
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated - Sort by creation date (asc by default)
    \n\n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "List lines of a PRODUCT_LOGISTIC_ORDER invoice document request", "value": { "data": [ { "delivery_bill_information": [], "entity_id": "1234567890-A-1", "entity_type": "PRODUCT_DEBIT", "id": "050f270d-8500-4185-acc7-3b11dc7da412", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "1234567890", "id": "1234567890-A", "reference_for_customer": "1234567890-C", "reference_for_seller": "1234567890-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "1234567890" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "1234567890-A" } ], "id": "1234567890-A-1" }, "price_excluding_taxes": 50, "product": { "references": [ { "reference": "3059412166368", "type": "EAN" } ], "sku": "3059412166368", "title": "Rica Lewis 46" }, "promotions": [], "quantity": 5, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 10, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 60, "unit_price_excluding_taxes": 10 }, { "delivery_bill_information": [], "entity_id": "1234567891-A-1", "entity_type": "PRODUCT_DEBIT", "id": "050f270d-8500-4185-acc7-3b11dc7da413", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "1234567891", "id": "1234567891-A", "reference_for_customer": "1234567891-C", "reference_for_seller": "1234567891-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "1234567891" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "1234567891-A" } ], "id": "1234567891-A-1" }, "price_excluding_taxes": 50, "product": { "references": [ { "reference": "0888755367001", "type": "EAN" } ], "sku": "0888755367001", "title": "Converse All Star" }, "promotions": [], "quantity": 1, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 10, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 60, "unit_price_excluding_taxes": 50 } ] } }, "application/json-1": { "summary": "List lines of a PRODUCT_LOGISTIC_ORDER credit note document request", "value": { "data": [ { "delivery_bill_information": [], "entity_id": "9876543210-A-1", "entity_type": "PRODUCT_CREDIT_REFUND", "id": "b2c3d4e5-1111-2222-3333-444455556666", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "9876543210", "id": "9876543210-A", "reference_for_customer": "9876543210-C", "reference_for_seller": "9876543210-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "9876543210" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "9876543210-A" } ], "id": "9876543210-A-1" }, "price_excluding_taxes": 20, "product": { "references": [ { "reference": "3059412166368", "type": "EAN" } ], "sku": "3059412166368", "title": "Rica Lewis 46" }, "quantity": 2, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 4, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 24, "unit_price_excluding_taxes": 10 }, { "delivery_bill_information": [], "entity_id": "9876543210-A-1", "entity_type": "PRODUCT_CREDIT_CANCEL", "id": "b2c3d4e5-1111-2222-3333-444455556667", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "9876543210", "id": "9876543210-A", "reference_for_customer": "9876543210-C", "reference_for_seller": "9876543210-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "9876543210" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "9876543210-A" } ], "id": "9876543210-A-1" }, "price_excluding_taxes": 50, "product": { "references": [ { "reference": "0888755367001", "type": "EAN" } ], "sku": "0888755367001", "title": "Converse All Star" }, "quantity": 1, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 10, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 60, "unit_price_excluding_taxes": 50 } ] } }, "application/json-2": { "summary": "List lines of a SHOP_BILLING_CYCLE_PURCHASE_ORDER invoice document request", "value": { "data": [ { "delivery_bill_information": [], "entity_id": "DS-2014-SAS657-A-1", "entity_type": "PURCHASE_ORDER_DEBIT", "id": "a1b2c3d4-5678-9abc-def0-111122223333", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "DS-2014-SAS657", "id": "DS-2014-SAS657-A", "reference_for_customer": "DS-2014-SAS657-C", "reference_for_seller": "DS-2014-SAS657-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "DS-2014-SAS657" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "DS-2014-SAS657-A" } ], "id": "DS-2014-SAS657-A-1" }, "price_excluding_taxes": 5000, "product": { "references": [ { "reference": "5413729247857", "type": "EAN" } ], "sku": "5413729247857", "title": "Apple iPhone 16 256GB Ultramarine" }, "promotions": [], "quantity": 5, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 1000, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 6000, "unit_price_excluding_taxes": 1000 }, { "delivery_bill_information": [], "entity_id": "DS-2014-SAS658-A-1", "entity_type": "PURCHASE_ORDER_DEBIT", "id": "a1b2c3d4-5678-9abc-def0-111122224444", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "DS-2014-SAS658", "id": "DS-2014-SAS658-A", "reference_for_customer": "DS-2014-SAS658-C", "reference_for_seller": "DS-2014-SAS658-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "DS-2014-SAS658" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "DS-2014-SAS658-A" } ], "id": "DS-2014-SAS658-A-1" }, "price_excluding_taxes": 1500, "product": { "references": [ { "reference": "0195949806506", "type": "EAN" } ], "sku": "0195949806506", "title": "Apple iPhone 16 Pro Max 512GB Black Titanium" }, "promotions": [], "quantity": 1, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 300, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 1800, "unit_price_excluding_taxes": 1500 } ] } }, "application/json-3": { "summary": "List lines of a SHOP_BILLING_CYCLE_PURCHASE_ORDER credit note document request", "value": { "data": [ { "delivery_bill_information": [], "entity_id": "DS-2014-SAS658-A-1", "entity_type": "PURCHASE_ORDER_CREDIT", "id": "b1c2d3e4-5678-9abc-def0-aabb11223355", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "DS-2014-SAS658", "id": "DS-2014-SAS658-A", "reference_for_customer": "DS-2014-SAS658-C", "reference_for_seller": "DS-2014-SAS658-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "DS-2014-SAS658" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "DS-2014-SAS658-A" } ], "id": "DS-2014-SAS658-A-1" }, "price_excluding_taxes": 1500, "product": { "references": [ { "reference": "0195949806506", "type": "EAN" } ], "sku": "0195949806506", "title": "Apple iPhone 16 Pro Max 512GB Black Titanium" }, "quantity": 1, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 300, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 1800, "unit_price_excluding_taxes": 1500 } ] } }, "application/json-4": { "summary": "List lines of a LOGISTIC_PURCHASE_ORDER invoice document request", "value": { "data": [ { "delivery_bill_information": [], "entity_id": "123123123-A-1", "entity_type": "PURCHASE_ORDER_DEBIT", "id": "c1d2e3f4-5678-9abc-def0-aabbccddeeff", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "123123123", "id": "123123123-A", "reference_for_customer": "123123123-C", "reference_for_seller": "123123123-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "123123123" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "123123123-A" } ], "id": "123123123-A-1" }, "price_excluding_taxes": 40, "product": { "references": [ { "reference": "3545540010609", "type": "EAN" } ], "sku": "3545540010609", "title": "Rape À Fromage Ménastyl" }, "promotions": [], "quantity": 4, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 8, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 48, "unit_price_excluding_taxes": 10 }, { "delivery_bill_information": [], "entity_id": "123123123-A-1", "entity_type": "PURCHASE_ORDER_DEBIT", "id": "c1d2e3f4-5678-9abc-def0-aabbccddeef0", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "123123123", "id": "123123123-A", "reference_for_customer": "123123123-C", "reference_for_seller": "123123123-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "123123123" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "123123123-A" } ], "id": "123123123-A-1" }, "price_excluding_taxes": 60, "product": { "references": [ { "reference": "8414271600043", "type": "EAN" } ], "sku": "8414271600043", "title": "Coupe-fromage lyre Lacor" }, "promotions": [], "quantity": 2, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 12, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 72, "unit_price_excluding_taxes": 30 } ] } }, "application/json-5": { "summary": "List lines of a LOGISTIC_PURCHASE_ORDER credit note document request", "value": { "data": [ { "delivery_bill_information": [], "entity_id": "123123123-A-1", "entity_type": "PURCHASE_ORDER_CREDIT", "id": "d2e3f4a5-6789-0abc-def1-aabbccddeef0", "order": { "additional_fields": [ { "code": "pvendor", "type": "STRING", "value": "PO-261" } ], "commercial_id": "123123123", "id": "123123123-A", "reference_for_customer": "123123123-C", "reference_for_seller": "123123123-S", "transaction_info": { "date": "2025-06-02T00:00:00Z", "number": "123123123" } }, "order_line": { "additional_fields": [ { "code": "PVNDR", "type": "STRING", "value": "123123123-A" } ], "id": "123123123-A-1" }, "price_excluding_taxes": 30, "product": { "references": [ { "reference": "8414271600043", "type": "EAN" } ], "sku": "8414271600043", "title": "Coupe-fromage lyre Lacor" }, "quantity": 1, "shipping_from": { "address": { "country_iso_code": "FRA" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [], "shipping_to": { "address": { "city": "Paris", "civility": "MRS", "company": "Mirakl", "country_iso_code": "FRA", "firstname": "Jeanne", "lastname": "Dupont", "state": "Île-de-France", "street1": "12, rue de Lübeck", "street2": "Bâtiment A", "zip_code": "75116" } }, "shop": { "id": 1234 }, "taxes": [ { "amount": 6, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 36, "unit_price_excluding_taxes": 30 } ] } }, "application/json-6": { "summary": "List lines of a FEES invoice document request", "value": { "data": [ { "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES_DEBIT_COMMISSION", "id": "d1e2f3a4-5678-9abc-def0-112233445566", "period": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z" }, "price_excluding_taxes": 60, "quantity": 1, "shop": { "id": 1234 }, "tax_legal_notice": "TVA non applicable - article 293 B du CGI", "taxes": [ { "amount": 12, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 72, "unit_price_excluding_taxes": 60 }, { "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES_DEBIT_SUBSCRIPTION", "id": "d1e2f3a4-5678-9abc-def0-112233445567", "period": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z" }, "price_excluding_taxes": 40, "quantity": 1, "shop": { "id": 1234 }, "taxes": [ { "amount": 8, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 48, "unit_price_excluding_taxes": 40 } ] } }, "application/json-7": { "summary": "List lines of a FEES credit note document request", "value": { "data": [ { "entity_id": "df3a1eb6-3947-4102-ad4e-ef621ad66671", "entity_type": "FEES_CREDIT_COMMISSION_REFUND", "id": "f2b3c4d5-6789-0abc-def1-223344556677", "period": { "date_from": "2023-12-01T00:00:00Z", "date_to": "2023-12-31T23:59:59.999Z" }, "price_excluding_taxes": 60, "quantity": 1, "shop": { "id": 1234 }, "tax_legal_notice": "TVA non applicable - article 293 B du CGI", "taxes": [ { "amount": 12, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 72, "unit_price_excluding_taxes": 60 } ] } }, "application/json-8": { "summary": "List lines of a ONE_OFF_FEES invoice document request", "value": { "data": [ { "description": "Platform listing fee", "entity_id": "b4eeffa4-e43d-431e-8195-15c15ed6a3d2", "entity_type": "FEES_DEBIT_ONE_OFF", "id": "e1f2a3b4-5678-9abc-def0-aabbccddeeff", "operation_date": "2025-06-01", "price_excluding_taxes": 60, "quantity": 1, "references": [], "shop": { "id": 1234 }, "taxes": [ { "amount": 12, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 72, "unit_price_excluding_taxes": 60 }, { "description": "Premium placement fee", "entity_id": "17cdbb7b-2b54-4f2a-9af5-6468bc3b1587", "entity_type": "FEES_DEBIT_ONE_OFF", "id": "e1f2a3b4-5678-9abc-def0-aabbccddeef0", "operation_date": "2025-06-01", "price_excluding_taxes": 40, "quantity": 1, "references": [], "shop": { "id": 1234 }, "tax_legal_notice": "TVA non applicable - article 293 B du CGI", "taxes": [ { "amount": 8, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 48, "unit_price_excluding_taxes": 40 } ] } }, "application/json-9": { "summary": "List lines of a ONE_OFF_FEES credit note document request", "value": { "data": [ { "description": "Platform listing fee refund", "entity_id": "b4eeffa4-e43d-431e-8195-15c15ed6a3d2", "entity_type": "FEES_CREDIT_ONE_OFF", "id": "f4e5d6c7-8901-abcd-ef01-334455667788", "operation_date": "2025-06-01", "price_excluding_taxes": 60, "quantity": 1, "references": [], "shop": { "id": 1234 }, "taxes": [ { "amount": 12, "code": "TVA", "rate": 20 } ], "total_price_including_taxes": 72, "unit_price_excluding_taxes": 60 } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "delivery_bill_information": [ { "delivery_bill_date": "string", "delivery_bill_id": "string" } ], "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "entity_id": "string", "entity_type": "PRODUCT_DEBIT", "fees_excluding_taxes": [ { "amount": 0, "code": "string", "label": "string" } ], "id": "string", "order": { "additional_fields": [ { "code": "string", "type": "STRING", "value": "string" } ], "commercial_id": "string", "date_created": "2023-03-28T09:34:42Z", "id": "string", "reference_for_customer": "string", "reference_for_seller": "string", "transaction_info": { "date": "2023-03-28T09:34:42Z", "number": "string" } }, "order_line": { "additional_fields": [ { "code": "string", "type": "STRING", "value": "string" } ], "id": "string" }, "origin_unit_price_excluding_taxes": 0, "origin_unit_price_including_taxes": 0, "price_excluding_taxes": 0, "product": { "references": [ { "reference": "string", "type": "string" } ], "sku": "string", "title": "string" }, "quantity": 0, "shipping_from": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" } }, "shipping_price_excluding_taxes": 0, "shipping_taxes": [ { "amount": 0, "code": "string", "rate": 0 } ], "shipping_to": { "address": { "city": "string", "civility": "string", "company": "string", "company2": "string", "country_iso_code": "string", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" } }, "shop": { "id": 0 }, "tax_legal_notice": "string", "taxes": [ { "amount": 0, "code": "string", "rate": 0 } ], "total_price_including_taxes": 0, "unit_price_excluding_taxes": 0 } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/DR12_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CUSTOMER_ACCOUNTING_DOCUMENT_REQUEST_READ", "ROLE_PARTNER_ACCOUNTING_DOCUMENT_READ" ] } ], "summary": "DR12 - List lines of a document request", "tags": [ "Invoicing and Accounting" ] } }, "/api/document-request/documents/download": { "get": { "description": "
    Description
    \n\nAt least one of the following filters must be applied: `document_id` or `entity_id`\n\nIf more than one document is requested, the output of the API will be a ZIP archive.\n\nThe tree structure of this archive is as follows:\n\n```\ndocuments-1624624030618.zip\n|\n|__ product-logistic-order/\n |__ order1-A/\n | |__ INV203837.pdf\n | |__ INV203837.cxml\n |__ order1-B/\n |__ INV203839.pdf\n```\n\n
    \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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PDF", "cXML" ] }, "maxItems": 100, "minItems": 0 }, "style": "form" }, { "description": "Entity identifiers related to the documents to download. This parameter can be supplied multiple times.
    The entity_type must be specified to use this filter, otherwise an error 400 will be returned.
    Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER", "explode": true, "in": "query", "name": "entity_id", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 100, "minItems": 0 }, "style": "form" }, { "description": "Entity types related to the documents to download. This parameter can be supplied multiple times.", "explode": true, "in": "query", "name": "entity_type", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PRODUCT_LOGISTIC_ORDER", "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "LOGISTIC_PURCHASE_ORDER", "FEES", "ONE_OFF_FEES" ] }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CUSTOMER_ACCOUNTING_DOCUMENT_READ", "ROLE_PARTNER_ACCOUNTING_DOCUMENT_READ" ] } ], "summary": "DR73 - Download accounting documents", "tags": [ "Invoicing and Accounting" ] } }, "/api/document-request/documents/upload": { "post": { "description": "
    Description
    \n\nDocuments filenames must be distinct.\n\nIf several formats are required for a document request, they must all be uploaded at once.\n\n**A maximum of 50 documents can be uploaded simultaneously.**\n\n
    \n
    ", "operationId": "DR74", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "documents_input": { "requests": [ { "document_number": "string", "due_date": "2023-03-28T09:34:42Z", "files": [ { "format": "PDF", "name": "string" } ], "issue_date": "2023-03-28T09:34:42Z", "request_id": "string", "total_amount_excluding_taxes": 0, "total_tax_amount": 0 } ] }, "files": [ "string" ] } } }, "schema": { "type": "object", "properties": { "documents_input": { "$ref": "#/components/schemas/DR74_Request_MultipartFormData_DocumentsInput", "description": "Information about documents to be uploaded" }, "files": { "type": "array", "description": "The files to be uploaded. Use multipart/form-data with name 'files'. The file names must contain only US-ASCII characters.", "items": { "type": "string", "format": "binary" } } }, "required": [ "documents_input", "files" ] } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "requests": [ { "errors": [], "input": { "document_number": "number document", "due_date": "2022-02-02T00:00:00Z", "files": [ { "format": "PDF", "name": "file-name.pdf" }, { "format": "cXML", "name": "file-name.xml" } ], "issue_date": "2022-01-02T00:00:00Z", "request_id": "fb057995-ae82-451a-99a6-356adbd86bbb" } }, { "errors": [ { "code": "DATA_NOT_FOUND", "field": "requestId", "message": "No document request found for request_id: fb811bad-8c05-4b2e-9975-88de70e4086a" } ], "input": { "document_number": "number document 2", "due_date": "2022-02-01T00:00:00Z", "files": [ { "format": "PDF", "name": "file-name2.pdf" } ], "issue_date": "2022-01-01T00:00:00Z", "request_id": "fb811bad-8c05-4b2e-9975-88de70e4086a" } }, { "errors": [ { "code": "DATA_NOT_FOUND", "field": "requestId", "message": "No document request found for request_id: 5a486cb3-64c2-4b94-9b33-fb6342cfe1a8" } ], "input": { "document_number": "number document 3", "due_date": "2022-12-31T00:00:00Z", "files": [ { "format": "PDF", "name": "invoice.pdf" } ], "issue_date": "2022-11-24T00:00:00Z", "request_id": "5a486cb3-64c2-4b94-9b33-fb6342cfe1a8", "total_amount_excluding_taxes": 410, "total_tax_amount": 0 } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "requests": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "input": { "document_number": "string", "due_date": "2023-03-28T09:34:42Z", "files": [ { "format": "PDF", "name": "string" } ], "issue_date": "2023-03-28T09:34:42Z", "request_id": "string", "total_amount_excluding_taxes": 0, "total_tax_amount": 0 } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/DR74_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CUSTOMER_ACCOUNTING_DOCUMENT_WRITE" ] } ], "summary": "DR74 - Upload accounting documents", "tags": [ "Invoicing and Accounting" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/document-request/documents/upload \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'documents_input=\"{\\\"requests\\\":[{\\\"document_number\\\":\\\"string\\\",\\\"due_date\\\":\\\"2023-03-28T09:34:42Z\\\",\\\"files\\\":[{\\\"format\\\":\\\"PDF\\\",\\\"name\\\":\\\"string\\\"}],\\\"issue_date\\\":\\\"2023-03-28T09:34:42Z\\\",\\\"request_id\\\":\\\"string\\\",\\\"total_amount_excluding_taxes\\\":0,\\\"total_tax_amount\\\":0}]}\";type=application/json' \\\n -F 'files=@path/to/file'\n" } ] } }, "/api/document-request/documents/confirm-issuance": { "post": { "description": "
    Description
    \n\nFor fees documents (`FEES`, `ONE_OFF_FEES`) issued externally, confirms the issuance details without uploading a document.\n\n**A maximum of 100 requests can be confirmed simultaneously.**\n\n
    \n
    ", "operationId": "DR75", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "requests": [ { "document_number": "INV-2022-0001", "due_date": "2022-02-02T00:00:00Z", "issue_date": "2022-01-02T00:00:00Z", "request_id": "4a29570a-5382-45af-9697-057de50f48a4", "total_amount_excluding_taxes": 32000, "total_tax_amount": 512 }, { "document_number": "INV-2022-0002", "due_date": "2022-02-02T00:00:00Z", "issue_date": "2022-01-02T00:00:00Z", "request_id": "7fd2bc17-5ca8-4383-a3b8-bb7e3ec6daf1", "total_amount_excluding_taxes": 32000, "total_tax_amount": 512 } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "requests": [ { "document_number": "string", "due_date": "2023-03-28T09:34:42Z", "issue_date": "2023-03-28T09:34:42Z", "request_id": "string", "total_amount_excluding_taxes": 0, "total_tax_amount": 0 } ] } } }, "schema": { "$ref": "#/components/schemas/DR75_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "requests": [ { "errors": [], "input": { "document_number": "INV-2022-0001", "due_date": "2022-02-02T00:00:00Z", "issue_date": "2022-01-02T00:00:00Z", "request_id": "4a29570a-5382-45af-9697-057de50f48a4", "total_amount_excluding_taxes": 32000, "total_tax_amount": 512 } }, { "errors": [], "input": { "document_number": "INV-2022-0002", "due_date": "2022-02-02T00:00:00Z", "issue_date": "2022-01-02T00:00:00Z", "request_id": "7fd2bc17-5ca8-4383-a3b8-bb7e3ec6daf1", "total_amount_excluding_taxes": 32000, "total_tax_amount": 512 } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "requests": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "input": { "document_number": "string", "due_date": "2023-03-28T09:34:42Z", "issue_date": "2023-03-28T09:34:42Z", "request_id": "string", "total_amount_excluding_taxes": 0, "total_tax_amount": 0 } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/DR75_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_CUSTOMER_ACCOUNTING_DOCUMENT_WRITE" ] } ], "summary": "DR75 - Confirm accounting documents issuance", "tags": [ "Invoicing and Accounting" ] } }, "/api/hierarchies": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every hour
    \n
    Maximum usage: Every hour
    \n
    Read More
    \n\n
    ", "operationId": "H11", "parameters": [ { "description": "Catalog category code", "explode": true, "in": "query", "name": "hierarchy", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Number of children catalog category levels to retrieve. If not specified, all child catalog categories are retrieved", "explode": true, "in": "query", "name": "max_level", "required": false, "schema": { "type": "integer", "format": "int32" }, "style": "form" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "hierarchies": [ { "code": "5911111", "label": "Suncare", "label_translations": [ { "locale": "en", "value": "Suncare" }, { "locale": "fr", "value": "Protection solaire" } ], "level": 2, "parent_code": "59" }, { "code": "5911112", "label": "Toiletries", "label_translations": [ { "locale": "en", "value": "Toiletries" }, { "locale": "fr", "value": "Articles de toilette" } ], "level": 2, "parent_code": "59" }, { "code": "5911113", "label": "Womens Hair Removal", "label_translations": [ { "locale": "en", "value": "Womens Hair Removal" }, { "locale": "fr", "value": "Épilation Femmes" } ], "level": 2, "parent_code": "59" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "hierarchies": [ { "code": "string", "label": "string", "label_translations": [ { "locale": "string", "value": "string" } ], "level": 0, "parent_code": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/H11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_CONFIGURATION_READ" ] } ], "summary": "H11 - List Catalog categories (parents and children) related to a Catalog category", "tags": [ "Products" ] } }, "/api/invoices": { "get": { "description": "
    Description
    \n\n⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, IV01 will contain no new data. Use the SBC11 and DR11 APIs instead.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day and as many times as there are invoice pages returned
    \n
    Maximum usage: Once per day and as many times as there are invoice pages returned
    \n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (asc by default)
    \n\n
    ", "operationId": "IV01", "parameters": [ { "description": "Currency code for filtering", "explode": true, "in": "query", "name": "currency", "required": false, "schema": { "type": "string", "enum": [ "AED", "ARS", "AUD", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "GEL", "GTQ", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "JOD", "JPY", "KES", "KRW", "KWD", "LKR", "MAD", "MGA", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "THB", "TWD", "UAH", "USD", "UYU", "UZS", "VND", "ZAR" ] }, "style": "form" }, { "description": "Creation date for filtering", "explode": true, "in": "query", "name": "end_date", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "OPERATOR", "BATCH", "PARTNER" ] }, "uniqueItems": true }, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "NOT_SPECIFIED", "MANGOPAY", "MIRAKL_PAYOUT", "OPERATOR" ] } }, "style": "form" }, { "description": "Accounting document payment state", "explode": true, "in": "query", "name": "payment_status", "required": false, "schema": { "type": "string", "enum": [ "PENDING", "PAID", "FAILED" ] }, "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "string", "default": "AUTO_INVOICE", "enum": [ "ALL", "AUTO_INVOICE", "MANUAL_INVOICE", "MANUAL_CREDIT" ] }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "invoices": [ { "currency_iso_code": "EUR", "date_created": "2018-10-02T15:45:30Z", "details": [ { "amount_excl_taxes": -3, "description": "Commissions of completed orders from 02/09/2018 to 02/11/2018", "quantity": 1, "taxes": [ { "amount": -4, "code": "TAX2" }, { "amount": -3, "code": "TAX3" } ] }, { "amount_excl_taxes": 2, "description": "Commissions of completed orders from 02/09/2018 to 02/11/2018", "quantity": 1, "taxes": [ { "amount": 3, "code": "TAX1" }, { "amount": 4, "code": "TAX2" } ] }, { "amount_excl_taxes": 3, "description": "Detailed accounting document item 2", "quantity": 1, "taxes": [ { "amount": 4, "code": "TAX2" }, { "amount": 3, "code": "TAX3" } ] }, { "amount_excl_taxes": 3, "description": "Seller fees on orders from 02/09/2018 to 02/11/2018", "quantity": 1, "taxes": [ { "amount": 4, "code": "TAX2" }, { "amount": 3, "code": "TAX3" } ] } ], "due_date": "2026-10-26T13:23:53Z", "end_time": "2018-11-02T15:45:30Z", "id": "4cd57d45-dabd-41a9-a472-2ee052c2aa06", "invoice_id": 2, "issue_date": "2026-10-26T13:23:53Z", "issuing_user": { "information": "Automatic action", "type": "BATCH" }, "pay_out_psp_code": "NOT_SPECIFIED", "payment": { "reference": null, "state": "PENDING", "transaction_date": null }, "payment_info": { "@type": "IBAN", "bank_city": "paris", "bank_name": "lcl", "bank_street": "12", "bank_zip": "75008", "bic": "Bic", "iban": "Iban", "owner": "owner" }, "payment_voucher_number": "123456", "seller_billing_cycle_id": "f212a4b3-b2fe-4df9-aae9-7e644ff23f5f", "shop_address": { "city": "Neuilly", "civility": "Mr", "company": "Mirakl", "complementary": "Pas très loin d'ici", "country": "FRANCE", "firstname": "Camille", "lastname": "Dumoulin", "phone": "01 72 31 62 00", "phone_secondary": "0687326711", "state": "IDF", "street1": "rue de la paix", "street2": "RDC G /s cours", "zip_code": "75100" }, "shop_corporate_name": "Ceasar Shop", "shop_id": 1, "shop_model": "MARKETPLACE", "shop_name": "The Shop", "shop_operator_internal_id": "op1234", "shop_tax_number": "TAX93248", "start_time": "2018-09-02T15:45:30Z", "state": "COMPLETE", "summary": { "amount_transferred": 0, "amount_transferred_to_operator": 17, "total_commissions_excl_tax": -2, "total_commissions_incl_tax": -9, "total_fee_excl_tax": 0, "total_fee_incl_tax": 0, "total_fee_operator_remitted_excl_tax": 0, "total_fee_operator_remitted_incl_tax": 0, "total_mirakl_ads_credit_excl_tax": 0, "total_mirakl_ads_credit_incl_tax": 0, "total_mirakl_ads_debit_excl_tax": 0, "total_mirakl_ads_debit_incl_tax": 0, "total_non_payable_orders_excl_tax": 0, "total_non_payable_orders_incl_tax": 0, "total_operator_paid_shipping_charges_excl_tax": 0, "total_operator_paid_shipping_charges_incl_tax": 0, "total_operator_remitted_taxes": 0, "total_other_credits_excl_tax": 0, "total_other_credits_incl_tax": 0, "total_other_invoices_excl_tax": 0, "total_other_invoices_incl_tax": 0, "total_payable_orders_excl_tax": 0, "total_payable_orders_incl_tax": 0, "total_purchase_taxes": 0, "total_refund_commissions_excl_tax": 3, "total_refund_commissions_incl_tax": 10, "total_refund_fee_excl_tax": 0, "total_refund_fee_incl_tax": 0, "total_refund_fee_operator_remitted_excl_tax": 0, "total_refund_fee_operator_remitted_incl_tax": 0, "total_refund_non_payable_orders_excl_tax": 0, "total_refund_non_payable_orders_incl_tax": 0, "total_refund_operator_paid_shipping_charges_excl_tax": 0, "total_refund_operator_paid_shipping_charges_incl_tax": 0, "total_refund_operator_remitted_taxes": 0, "total_refund_orders_excl_tax": 0, "total_refund_orders_incl_tax": 0, "total_refund_payable_orders_excl_tax": 0, "total_refund_payable_orders_incl_tax": 0, "total_refund_purchase_taxes": 0, "total_seller_fees_on_orders_excl_tax": -5, "total_seller_fees_on_orders_incl_tax": -8, "total_seller_penalty_fees_excl_tax": 0, "total_seller_penalty_fees_incl_tax": 0, "total_subscription_excl_tax": -3, "total_subscription_incl_tax": -10 }, "total_amount_excl_taxes": 981, "total_amount_incl_taxes": 1002, "total_charged_amount": 1002, "total_taxes": [ { "amount": 3, "code": "TAX1" }, { "amount": 4, "code": "TAX2" }, { "amount": 4, "code": "TAX2" }, { "amount": 3, "code": "TAX3" } ], "type": "AUTO_INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2018-10-06T15:45:30Z", "details": [ { "amount_excl_taxes": 1, "description": "Detailed accounting document item 1", "operation_date": "2017-10-06T15:45:30Z", "quantity": 7, "taxes": [ { "amount": 3, "code": "TAX1" }, { "amount": 4, "code": "TAX2" } ] }, { "amount_excl_taxes": 3, "description": "Detailed accounting document item 2", "operation_date": "2017-10-06T15:45:30Z", "quantity": 6, "taxes": [ { "amount": 3, "code": "TAX3" }, { "amount": 4, "code": "TAX4" } ] } ], "due_date": "2026-10-26T13:23:53Z", "id": "84ba3367-51f5-4bb5-9535-9254b7595ed3", "invoice_id": 6, "issue_date": "2026-10-26T13:23:53Z", "issuing_user": { "information": "testuser@mirakl.com", "type": "PARTNER" }, "pay_out_psp_code": "NOT_SPECIFIED", "payment": { "reference": null, "state": "PENDING", "transaction_date": null }, "payment_voucher_number": "123456", "seller_billing_cycle_id": "57061ac1-946d-4107-b6c7-f02f5642da3f", "shop_address": { "city": "Neuilly", "civility": "Mr", "company": "Mirakl", "complementary": "Pas très loin d'ici", "country": "FRANCE", "firstname": "Camille", "lastname": "Dumoulin", "phone": "01 72 31 62 00", "phone_secondary": "0687326711", "state": "IDF", "street1": "rue de la paix", "street2": "RDC G /s cours", "zip_code": "75100" }, "shop_corporate_name": "Ceasar Shop", "shop_id": 2, "shop_model": "MARKETPLACE", "shop_name": "The Shop", "shop_operator_internal_id": "op1234", "shop_tax_number": "TAX93248", "state": "COMPLETE", "total_amount_excl_taxes": 980, "total_amount_incl_taxes": 1006, "total_charged_amount": 1006, "total_taxes": [ { "amount": 3, "code": "TAX1" }, { "amount": 4, "code": "TAX2" }, { "amount": 3, "code": "TAX3" }, { "amount": 4, "code": "TAX4" } ], "type": "MANUAL_INVOICE" }, { "currency_iso_code": "EUR", "date_created": "2018-10-06T15:45:30Z", "details": [ { "amount_excl_taxes": 3, "description": "Detailed accounting document item 3", "operation_date": "2017-10-06T15:45:30Z", "quantity": 1, "taxes": [ { "amount": 3, "code": "TAX3" }, { "amount": 4, "code": "TAX4" } ] } ], "id": "8da2cde0-38dc-4427-a1de-a6250ca37b8b", "invoice_id": 7, "issuing_user": { "information": "testuser@mirakl.com", "type": "PARTNER" }, "pay_out_psp_code": "NOT_SPECIFIED", "payment": { "failure_reason": "INCOMPLETE_KYC", "reference": null, "state": "FAILED", "transaction_date": null }, "seller_billing_cycle_id": "57061ac1-946d-4107-b6c7-f02f5642da3f", "shop_address": { "city": "Neuilly", "civility": "Mr", "company": "Mirakl", "complementary": "Pas très loin d'ici", "country": "FRANCE", "firstname": "Camille", "lastname": "Dumoulin", "phone": "01 72 31 62 00", "phone_secondary": "0687326711", "state": "IDF", "street1": "rue de la paix", "street2": "RDC G /s cours", "zip_code": "75100" }, "shop_corporate_name": "Ceasar Shop", "shop_id": 2, "shop_model": "MARKETPLACE", "shop_name": "The Shop", "shop_operator_internal_id": "op1234", "shop_tax_number": "TAX93248", "state": "COMPLETE", "total_amount_excl_taxes": 980, "total_amount_incl_taxes": 1006, "total_charged_amount": 1006, "total_taxes": [ { "amount": 3, "code": "TAX3" }, { "amount": 4, "code": "TAX4" } ], "type": "MANUAL_INVOICE" } ], "total_count": 3 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "invoices": [ { "currency_iso_code": "AED", "date_created": "2023-03-28T09:34:42Z", "details": [ { "amount_excl_taxes": 0, "description": "string", "operation_date": "2023-03-28T09:34:42Z", "order_id": "string", "quantity": 0, "taxes": [ { "amount": 0, "code": "string" } ] } ], "due_date": "2023-03-28T09:34:42Z", "id": "string", "invoice_id": 0, "issue_date": "2023-03-28T09:34:42Z", "issuing_user": { "information": "string", "type": "OPERATOR" }, "pay_out_psp_code": "NOT_SPECIFIED", "payment": { "failure_reason": "INCOMPLETE_KYC", "reference": "string", "state": "PENDING", "transaction_date": "2023-03-28T09:34:42Z" }, "shop_address": { "city": "string", "civility": "string", "company": "string", "complementary": "string", "country": "string", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" }, "shop_corporate_name": "string", "shop_id": 0, "shop_model": "MARKETPLACE", "shop_name": "string", "shop_operator_internal_id": "string", "shop_tax_number": "string", "state": "string", "total_amount_excl_taxes": 0, "total_amount_incl_taxes": 0, "total_charged_amount": 0, "total_taxes": [ { "amount": 0, "code": "string" } ], "type": "ALL" } ], "total_count": 0 } } }, "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": "IV01 - List accounting documents", "tags": [ "Invoicing and Accounting" ] } }, "/api/invoices/{accounting_document_id}": { "get": { "description": "
    Description
    \n\n⚠️ 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.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each invoice download
    \n
    Maximum usage: At each invoice download
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "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": "IV02 - Download an accounting document", "tags": [ "Invoicing and Accounting" ] } }, "/api/locales": { "get": { "description": "
    Description
    \n\nList locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "locales": [ { "code": "de_DE", "label": "Deutsch" }, { "code": "en_US", "label": "English - US", "platform_default": true }, { "code": "es_ES", "label": "Español" }, { "code": "fr_FR", "label": "Français" }, { "code": "it_IT", "label": "Italiano" }, { "code": "nl_NL", "label": "Nederlands" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "locales": [ { "code": "string", "label": "string", "platform_default": true } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/L01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_I18N_SETTINGS_READ" ] } ], "summary": "L01 - List locale codes and labels", "tags": [ "Platform Settings" ] } }, "/api/messages": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be permanently removed **on April 5 2027**, please use M10 and M11 instead.\n\n
    Description
    \n\nReturns messages received or sent to the shop. By default, returns only messages that are received by the shop.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Synchronous only - at each message list display
    \n
    Maximum usage: Synchronous only - at each message list display
    \n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (desc by default)
    \n\n
    ", "operationId": "M01", "parameters": [ { "description": "Returns messages concerned by this customer_id", "explode": true, "in": "query", "name": "customer_id", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "
    • If TRUE: returns only messages received by shop.
    • If FALSE: returns only messages sent to the shop.
    ", "explode": true, "in": "query", "name": "received", "required": false, "schema": { "type": "string", "default": "TRUE", "enum": [ "TRUE", "FALSE", "ALL" ] }, "style": "form" }, { "description": "Order identifier", "explode": true, "in": "query", "name": "order_id", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Offer identifier", "explode": true, "in": "query", "name": "offer_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" }, { "description": "Start creation date for filtering", "explode": true, "in": "query", "name": "start_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "End creation date for filtering", "explode": true, "in": "query", "name": "end_date", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "messages": [ { "archived": false, "body": "Hi,

    Could you please deliver the customer as soon as possible

    Many Thanks", "commercial_id": "Classic_Order_0006", "date_created": "2019-04-01T14:09:06Z", "documents": [ { "date_uploaded": "2019-04-01T14:09:06Z", "file_name": "response2.csv", "file_size": 519, "id": 2028, "type": "CUSTOMER_INVOICE" } ], "from_id": "1", "from_name": "Operator", "from_type": "OPERATOR", "id": 2030, "order_id": "Classic_Order_0006-A", "read": false, "subject": "Item not received", "to_shop_archived": false, "to_shop_id": 2000, "to_shop_name": "ACME SHOP" } ], "total_count": 1 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "messages": [ { "archived": true, "body": "string", "commercial_id": "string", "date_created": "2023-03-28T09:34:42Z", "documents": [ { "date_uploaded": "2023-03-28T09:34:42Z", "file_name": "string", "file_size": 0, "id": 0, "type": "string" } ], "from_id": "string", "from_name": "string", "from_type": "OPERATOR", "id": 0, "offer_id": 0, "order_id": "string", "read": true, "subject": "string", "to_customer_archived": true, "to_customer_id": "string", "to_customer_name": "string", "to_operator": true, "to_operator_archived": true, "to_shop_archived": true, "to_shop_id": 0, "to_shop_name": "string", "visible": true } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/M01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "M01 - List messages linked to orders and offers", "tags": [ "Messages" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/inbox/threads/{thread_id}": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Synchronous only - At each page that includes a message thread display
    \n
    Maximum usage: Synchronous only - At each page that includes a message thread display
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "authorized_participants": [ { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, { "display_name": "Customer display name", "id": "Customer id", "type": "CUSTOMER" } ], "current_participants": [ { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, { "display_name": "Customer display name", "id": "Customer id", "type": "CUSTOMER" } ], "customer_organization": { "display_name": "Customer organization", "id": "customer-org-id" }, "date_created": "2018-10-02T08:36:36.479Z", "date_updated": "2018-10-03T09:40:17.241Z", "entities": [ { "id": "Entity id", "label": "Entity label", "type": "Entity type" } ], "id": "702c3e56-dcca-41e2-b6bd-72ba3fa809be", "messages": [ { "body": "Hello, I have recently order a service and I have a few questions ...", "date_created": "2018-10-02T08:36:36.479Z", "from": { "display_name": "Customer display name", "type": "CUSTOMER_USER" }, "id": "df4a3163-a44b-4c5f-8380-faebfa43ca68", "to": [ { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" } ] }, { "attachments": [ { "id": "fce1742e-8160-45ed-b88a-100023d9d97b", "name": "Brochure du service", "size": 200 }, { "id": "983fd83f-0b39-4bdf-9932-bd774ab66ce4", "name": "Tarif", "size": 10 } ], "body": "Dear customer, ...", "date_created": "2018-10-03T09:40:17.241Z", "from": { "display_name": "Shop user display name", "organization_details": { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, "type": "SHOP_USER" }, "id": "d752f26f-03eb-499c-8f4d-828fa9640055", "to": [ { "display_name": "Customer display name", "id": "Customer id", "type": "CUSTOMER" } ] } ], "metadata": { "last_message_date": "2018-10-03T09:40:17.241Z", "last_sender": { "display_name": "Shop user display name", "organization_details": { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, "type": "SHOP_USER" }, "shop_reply_needed_since": null, "total_count": 2 }, "no_store_reply_needed": [], "topic": { "type": "FREE_TEXT", "value": "Questions about my order" } } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "authorized_participants": [ { "display_name": "string", "id": "string", "type": "OPERATOR" } ], "current_participants": [ { "display_name": "string", "id": "string", "type": "OPERATOR" } ], "customer_organization": { "display_name": "string", "id": "string" }, "date_created": "2023-03-28T09:34:42Z", "date_updated": "2023-03-28T09:34:42Z", "entities": [ { "id": "string", "label": "string", "type": "string" } ], "id": "string", "messages": [ { "attachments": [ { "id": "string", "name": "string", "size": 0 } ], "body": "string", "date_created": "2023-03-28T09:34:42Z", "from": { "display_name": "string", "organization_details": { "display_name": "string", "id": "string", "type": "OPERATOR" }, "type": "OPERATOR_USER" }, "id": "string", "to": [ { "display_name": "string", "id": "string", "type": "OPERATOR" } ] } ], "metadata": { "last_message_date": "2023-03-28T09:34:42Z", "last_sender": { "display_name": "string", "organization_details": { "display_name": "string", "id": "string", "type": "OPERATOR" }, "type": "OPERATOR_USER" }, "shop_reply_needed_since": "2023-03-28T09:34:42Z", "total_count": 0 }, "no_store_reply_needed": [ { "date": "2023-03-28T09:34:42Z", "user_type": "OPERATOR" } ], "topic": { "type": "FREE_TEXT", "value": "string" } } } }, "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": "M10 - Retrieve a thread", "tags": [ "Messages" ] } }, "/api/inbox/threads": { "get": { "description": "
    Description
    \n\nYou may want to retrieve the threads linked to a specific entity, using both entity_type and entity_id.\n
    For example, to retrieve threads for an order, use entity_type=MMP_ORDER&entity_id=my-order-1.\n
    \nAvailable values for entity_type are:\n
      \n
    • MMP_ORDER: for threads on product orders
      • \n
    • MMP_OFFER: for threads on offers
      • \n
    • MPS_ORDER: for threads on service orders
      • \n
    • MPS_SERVICE: for threads on services
      • \n
    • SELLER_OPERATOR: for threads between sellers and operator
      • \n
    \n\nThis resource uses seek pagination. The default value for parameter limit is 50.\n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Synchronous only - At each page that includes an inbox display
    \n
    Maximum usage: Synchronous only - At each page that includes an inbox display
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    ", "operationId": "M11", "parameters": [ { "description": "Entity type to include in result (default: include all).
    Available values: MMP_ORDER, MMP_OFFER, MPS_ORDER, MPS_SERVICE, SELLER_OPERATOR", "explode": true, "in": "query", "name": "entity_type", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Comma separated list of Entity id to include in result (default: include all).
    The entity_type must be specified to use this filter, otherwise an error 400 will be returned.
    Example of an entity_id query: entity_id=order1-A,order20-A,order13-A&entity_type=MMP_ORDER", "explode": true, "in": "query", "name": "entity_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Retrieve threads modified at or after this date.", "explode": true, "in": "query", "name": "updated_since", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "True to include message details. Limited to the last 100 messages received on each thread.", "explode": true, "in": "query", "name": "with_messages", "required": false, "schema": { "type": "boolean", "default": false }, "style": "form" }, { "description": "List of the channel codes to filter with, using a comma (,) as a separator.\n
    If specified, only order messages linked to the given channels will be returned (Whatever the value of entity_type).\n
    Otherwise, messages will be returned regardless of their channels.\n", "explode": true, "in": "query", "name": "channel_codes", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "authorized_participants": [ { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, { "display_name": "Customer display name", "id": "Customer id", "type": "CUSTOMER" } ], "current_participants": [ { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, { "display_name": "Customer display name", "id": "Customer id", "type": "CUSTOMER" } ], "customer_organization": { "display_name": "Customer organization", "id": "customer-org-id" }, "date_created": "2016-09-03T13:37:00Z", "date_updated": "2018-09-03T13:37:00Z", "entities": [ { "id": "Entity id", "label": "Entity label", "type": "Entity type" } ], "id": "702c3e56-dcca-41e2-b6bd-72ba3fa809be", "metadata": { "last_message_date": "2018-09-03T13:37:00Z", "last_sender": { "display_name": "Shop user display name", "organization_details": { "display_name": "Shop display name", "id": "Shop id", "type": "SHOP" }, "type": "SHOP_USER" }, "shop_reply_needed_since": null, "total_count": 2 }, "no_store_reply_needed": [], "topic": { "type": "FREE_TEXT", "value": "Topic value" } } ], "next_page_token": "bGltaXQ9NTAmYWZ0ZXI9MjA3NjYwNTAtZDc5Yy00YzUyLWEwODctZWI5YjY1MjFkNzA5JnNvcnQ9ZGF0ZSxERVND.jFoPX_GjfbaRV88hhNxWWEzeRSqPt1WNExsrcBTkuSY=" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "authorized_participants": [ { "display_name": "string", "id": "string", "type": "OPERATOR" } ], "current_participants": [ { "display_name": "string", "id": "string", "type": "OPERATOR" } ], "customer_organization": { "display_name": "string", "id": "string" }, "date_created": "2023-03-28T09:34:42Z", "date_updated": "2023-03-28T09:34:42Z", "entities": [ { "id": "string", "label": "string", "type": "string" } ], "id": "string", "messages": [ { "attachments": [ { "id": "string", "name": "string", "size": 0 } ], "body": "string", "date_created": "2023-03-28T09:34:42Z", "from": { "display_name": "string", "organization_details": { "display_name": "string", "id": "string", "type": "OPERATOR" }, "type": "OPERATOR_USER" }, "id": "string", "to": [ { "display_name": "string", "id": "string", "type": "OPERATOR" } ] } ], "metadata": { "last_message_date": "2023-03-28T09:34:42Z", "last_sender": { "display_name": "string", "organization_details": { "display_name": "string", "id": "string", "type": "OPERATOR" }, "type": "OPERATOR_USER" }, "shop_reply_needed_since": "2023-03-28T09:34:42Z", "total_count": 0 }, "no_store_reply_needed": [ { "date": "2023-03-28T09:34:42Z", "user_type": "OPERATOR" } ], "topic": { "type": "FREE_TEXT", "value": "string" } } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/M11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_MESSAGE_READ", "ROLE_PARTNER_MESSAGE_READ" ] } ], "summary": "M11 - List all threads", "tags": [ "Messages" ] }, "post": { "description": "
    Description
    \n\nCreate a thread with the operator and send a first message\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Synchronous only - At each thread
    \n
    Maximum usage: Synchronous only - At each thread answer
    \n
    ", "operationId": "M14", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "files": [ "string" ], "thread_input": { "body": "string", "entity": { "type": "string" }, "topic": { "type": "FREE_TEXT", "value": "string" } } } } }, "schema": { "type": "object", "properties": { "files": { "type": "array", "description": "List of attachments for the message
    Maximum 1000 across all threads of the same entity.
    For example, for a given seller, you can not have more than 1000 attachments across all its threads.", "items": { "type": "string", "format": "binary" } }, "thread_input": { "$ref": "#/components/schemas/M14_Request_MultipartFormData_ThreadInput", "description": "Message and thread data" } }, "required": [ "thread_input" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "message_id": "873f1cb5-a7a2-4e07-8e0e-12eb64e93ece", "thread_id": "702c3e56-dcca-41e2-b6bd-72ba3fa809be" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "message_id": "string", "thread_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/M14_Response_201" } } }, "description": "Created" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "M14 - Create a thread with the operator", "tags": [ "Messages" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/inbox/threads \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'files=@path/to/file' \\\n -F 'thread_input=\"{\\\"body\\\":\\\"string\\\",\\\"entity\\\":{\\\"type\\\":\\\"string\\\"},\\\"topic\\\":{\\\"type\\\":\\\"FREE_TEXT\\\",\\\"value\\\":\\\"string\\\"}}\";type=application/json'\n" } ] } }, "/api/inbox/threads/{thread_id}/message": { "post": { "description": "
    Description
    \n\nMaximum of 1000 messages on a thread\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Synchronous only - At each thread answer
    \n
    Maximum usage: Synchronous only - At each thread answer
    \n
    ", "operationId": "M12", "parameters": [ { "description": "The ID of the thread to reply to.", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "files": [ "string" ], "message_input": { "body": "string", "to": [ { "id": "string", "type": "OPERATOR" } ], "topic": { "type": "FREE_TEXT", "value": "string" } } } } }, "schema": { "type": "object", "properties": { "files": { "type": "array", "description": "List of attachments for the message
    Maximum 50 across all threads of the same entity.
    For example, for a given order, you can not have more than 50 attachments across all its threads.", "items": { "type": "string", "format": "binary" } }, "message_input": { "$ref": "#/components/schemas/M12_Request_MultipartFormData_MessageInput", "description": "The message data" } }, "required": [ "message_input" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "message_id": "873f1cb5-a7a2-4e07-8e0e-12eb64e93ece", "thread_id": "702c3e56-dcca-41e2-b6bd-72ba3fa809be" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "message_id": "string", "thread_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/M12_Response_201" } } }, "description": "Created" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_MESSAGE_WRITE", "ROLE_PARTNER_MESSAGE_WRITE" ] } ], "summary": "M12 - Reply to a thread", "tags": [ "Messages" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/inbox/threads/{thread_id}/message \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'files=@path/to/file' \\\n -F 'message_input=\"{\\\"body\\\":\\\"string\\\",\\\"to\\\":[{\\\"id\\\":\\\"string\\\",\\\"type\\\":\\\"OPERATOR\\\"}],\\\"topic\\\":{\\\"type\\\":\\\"FREE_TEXT\\\",\\\"value\\\":\\\"string\\\"}}\";type=application/json'\n" } ] } }, "/api/inbox/threads/{attachment_id}/download": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Synchronous only - At each message attachment download
    \n
    Maximum usage: Synchronous only - At each message attachment download
    \n
    ", "operationId": "M13", "parameters": [ { "description": "The identifier of the attachment to retrieve.", "explode": false, "in": "path", "name": "attachment_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_MESSAGE_READ", "ROLE_PARTNER_MESSAGE_READ" ] } ], "summary": "M13 - Download an attachment", "tags": [ "Messages" ] } }, "/api/offers/imports": { "post": { "description": "
    Description
    \n\nReturns the import identifier to track the status of the import.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 5 minutes with offers only, every hour with offers and products, for each seller
    \n
    Maximum usage: Once per minute with offers only, once every 15 minutes with offers and products, for each seller
    \n
    Read More
    \n\n
    ", "operationId": "OF01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-0": { "summary": "text/csv payload", "value": { "file": "sku;product-id;product-id-type;description;internal-description;price-additional-info;quantity;min-quantity-alert;state;available-start-date;available-end-date;logistic-class;update-delete;discount-start-date;discount-end-date;price;discount-price;discount-ranges;price-ranges;discount-start-date[channel=FR];discount-end-date[channel=FR];price[channel=FR];discount-price[channel=FR];discount-ranges[channel=FR];prices-ranges[channel=FR];discount-start-date[channel=CA];discount-end-date[channel=CA];price[channel=CA];discount-price[channel=CA];discount-ranges[channel=CA];prices-ranges[channel=CA];leadtime-to-ship;ecotax;gift-wrap;min-quantity-ordered;producer-id[FR-DEA];eco-contribution-amount[FR-DEA];producer-id[DE-WEEE];eco-contribution-amount[DE-WEEE]\nOFFER_SKU_004;MKP100000000037254;SKU;My Offer Description n∞1;My Internal description 1;My price Additional innformations;1000000;20;11;2017-02-20T10:45:53+01;2017-04-30T10:45:53+01;S;update;2017-02-22T10:45:53+01;2017-04-30T10:45:53+01;110.52;108,56;;5|109.20,10|108.736;2017-02-22T10:45:53+01;2017-03-31T10:45:53+01;105.56;102,36;;5|104.56,10|103.27;2017-02-22T10:45:53+01;2017-03-31T10:45:53+01;190.23;175,36;;5|182.58,10|181.27;15;1;true;1;FR123456_89ABCD;3.59;ProducerID1;0.99\n", "import_mode": "NORMAL", "operator_format": true, "with_products": true } }, "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "file": "string", "import_mode": "NORMAL", "operator_format": true, "with_products": true } } }, "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Import file (CSV or XML or XLSX) to upload. Use multipart/form-data with name file.
    Csv format:
    \"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\"


    If you use specific sales channels, use: 
    \"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]\"

    If you use the price per measurement unit feature, use pricing-unit to specify the unit corresponding to the submitted price.

    If US Tax options are activated on the platform, use: product-tax-code to facilitate tax calculations.

    If Data collection related to circular economy regulations is enabled, use:
    \"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

    " }, "import_mode": { "type": "string", "description": "Enum: `\"NORMAL\"`, `\"REPLACE\"`\n\n
    \n See deprecated values\n\n Deprecated values: `\"PARTIAL_UPDATE\"`\n
    \n" }, "operator_format": { "type": "boolean", "default": false, "description": "Force the use of the operator product format" }, "with_products": { "type": "boolean", "default": false, "description": "This file also contains product information" } }, "required": [ "file", "import_mode" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "import_id": 2035, "product_import_id": 2036 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "import_id": 0, "product_import_id": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF01_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": "OF01 - Import a file to create, update or delete offers", "tags": [ "Offers" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/offers/imports \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'file=@path/to/file' \\\n -F 'import_mode=\"\\\"NORMAL\\\"\";type=application/json' \\\n -F 'operator_format=\"true\";type=application/json' \\\n -F 'with_products=\"true\";type=application/json'\n" } ] }, "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (desc by default)
    \n\n
    ", "operationId": "OF04", "parameters": [ { "description": "Start creation date for filtering", "explode": true, "in": "query", "name": "start_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "End creation date for filtering", "explode": true, "in": "query", "name": "end_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Offer import status", "explode": true, "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "WAITING_SYNCHRONIZATION_PRODUCT", "WAITING", "RUNNING", "COMPLETE", "FAILED" ] }, "style": "form" }, { "description": "Offer import mode", "explode": true, "in": "query", "name": "mode", "required": false, "schema": { "type": "string", "enum": [ "NORMAL", "REPLACE" ] }, "style": "form" }, { "description": "List of offer import origins for filtering. This parameter can be supplied multiple times (origins=API&origins=FTP...).", "explode": true, "in": "query", "name": "origins", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "API", "FTP", "SFTP", "HTTP", "HTTPS", "FRONT", "PENDING_OFFERS" ] } }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "date_created": "2021-05-11T14:50:25Z", "has_error_report": false, "import_id": 2029, "lines_in_error": 0, "lines_in_pending": 0, "lines_in_success": 8, "lines_read": 8, "mode": "NORMAL", "offer_deleted": 3, "offer_inserted": 3, "offer_updated": 2, "origin": "FRONT", "shop_id": 123, "status": "COMPLETE" }, { "date_created": "2021-05-11T14:50:25Z", "has_error_report": true, "import_id": 2028, "lines_in_error": 1, "lines_in_pending": 0, "lines_in_success": 9, "lines_read": 10, "mode": "NORMAL", "offer_deleted": 3, "offer_inserted": 3, "offer_updated": 3, "origin": "API", "reason_status": "A parsing error has occurred at line 10", "shop_id": 123, "status": "WAITING" } ], "next_page_token": "bGltaXQ9MiZhZnRlcj0yMDIxLTA1LTExJTIwMTY6NTA6MjUuNDczJnNvcnQ9ZGF0ZUNyZWF0ZWQsREVTQw==", "previous_page_token": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "date_created": "2023-03-28T09:34:42Z", "has_error_report": true, "import_id": 0, "lines_in_error": 0, "lines_in_pending": 0, "lines_in_success": 0, "lines_read": 0, "mode": "NORMAL", "offer_deleted": 0, "offer_inserted": 0, "offer_updated": 0, "origin": "API", "reason_status": "string", "shop_id": 0, "status": "WAITING_SYNCHRONIZATION_PRODUCT" } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF04_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_WRITE", "ROLE_PARTNER_OFFER_TRACKING_READ" ] } ], "summary": "OF04 - Get information and statistics about offer imports", "tags": [ "Offers" ] } }, "/api/offers/imports/{import}": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: After each OF01 call, every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "OF02", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "date_created": "2019-04-01T15:16:31Z", "has_error_report": false, "import_id": 2035, "lines_in_error": 0, "lines_in_pending": 0, "lines_in_success": 1, "lines_read": 1, "mode": "NORMAL", "offer_deleted": 0, "offer_inserted": 1, "offer_updated": 0, "status": "COMPLETE" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "date_created": "2023-03-28T09:34:42Z", "has_error_report": true, "import_id": 0, "lines_in_error": 0, "lines_in_pending": 0, "lines_in_success": 0, "lines_read": 0, "mode": "NORMAL", "offer_deleted": 0, "offer_inserted": 0, "offer_updated": 0, "reason_status": "string", "status": "WAITING_SYNCHRONIZATION_PRODUCT", "type": "AUTO" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_WRITE", "ROLE_PARTNER_OFFER_TRACKING_READ" ] } ], "summary": "OF02 - Get information and statistics about an offer import", "tags": [ "Offers" ] } }, "/api/offers/imports/{import}/error_report": { "get": { "description": "
    Description
    \n\nThis API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: After each OF02 call, every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "OF03", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-0": { "summary": "Example with business values (application/octet-stream)", "value": "\"sku\";\"product-id\";\"product-id-type\";\"description\";\"internal-description\";\"price-additional-info\";\"quantity\";\"min-quantity-alert\";\"state\";\"available-start-date\";\"available-end-date\";\"logistic-class\";\"update-delete\";\"discount-start-date\";\"discount-end-date\";\"price\";\"discount-price\";\"discount-ranges\";\"price-ranges\";\"discount-start-date[channel=FR]\";\"discount-end-date[channel=FR]\";\"price[channel=FR]\";\"discount-price[channel=FR]\";\"discount-ranges[channel=FR]\";\"prices-ranges[channel=FR]\";\"discount-start-date[channel=CA]\";\"discount-end-date[channel=CA]\";\"price[channel=CA]\";\"discount-price[channel=CA]\";\"discount-ranges[channel=CA]\";\"prices-ranges[channel=CA]\";\"leadtime-to-ship\";\"error-line\";\"error-message\"\n\"OFFER_SKU_004\";\"MKP100000000195360\";\"SKU\";\"My Offer Description n°1\";\"My Internal description 1\";\"My price Additional innformations\";\"1000000\";\"20\";\"11\";\"2017-02-20T10:45:53+01\";\"2017-04-30T10:45:53+01\";\"S\";\"update\";\"2017-02-22T10:45:53+01\";\"2017-04-30T10:45:53+01\";\"110.52\";\"108,56\";\"\";\"5|109.20,10|108.736\";\"2017-02-22T10:45:53+01\";\"2017-03-31T10:45:53+01\";\"105.56\";\"102,36\";\"\";\"5|104.56,10|103.27\";\"2017-02-22T10:45:53+01\";\"2017-03-31T10:45:53+01\";\"190.23\";\"175,36\";\"\";\"5|182.58,10|181.27\";\"15\";\"2\";\"The product does not exist\"\n" }, "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_WRITE", "ROLE_PARTNER_OFFER_TRACKING_READ" ] } ], "summary": "OF03 - Get the error report file for an offer import", "tags": [ "Offers" ] } }, "/api/offers": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: On each shop's offers page view
    \n
    Maximum usage: On each shop's offers page view
    \n
    Read More
    \n\n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • totalPrice (Default) - Sort by total price (asc by default)
    • price - Sort by price, total price (asc by default)
    • productTitle - Sort by product title, total price (asc by default)
    \n\n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "OF21", "parameters": [ { "description": "List of offer state codes", "explode": true, "in": "query", "name": "offer_state_codes", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Offer's sku", "explode": true, "in": "query", "name": "sku", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Product's sku", "explode": true, "in": "query", "name": "product_id", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter only favorite offers", "explode": true, "in": "query", "name": "favorite", "required": false, "schema": { "type": "boolean", "default": false }, "style": "form" }, { "description": "Filter used to pick prices on a specific channel", "explode": true, "in": "query", "name": "pricing_channel_code", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values for single channel pricing users (application/json)", "value": { "offers": [ { "active": true, "all_prices": [ { "channel_code": null, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 49, "unit_discount_price": 49, "unit_origin_price": 50, "volume_prices": [ { "price": 49, "quantity_threshold": 1, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 50, "unit_discount_price": 44, "unit_origin_price": 45 }, { "price": 39, "quantity_threshold": 100, "unit_discount_price": 39, "unit_origin_price": 40 } ] }, { "channel_code": "US", "context": { "channel_codes": [ "US" ] }, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 59, "unit_discount_price": 59, "unit_origin_price": 60, "volume_prices": [ { "price": 59, "quantity_threshold": 1, "unit_discount_price": 59, "unit_origin_price": 60 }, { "price": 49, "quantity_threshold": 50, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 100, "unit_discount_price": 44, "unit_origin_price": 45 } ] }, { "channel_code": "US", "context": { "channel_codes": [ "US" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] } ], "allow_quote_requests": false, "applicable_pricing": { "channel_code": "US", "context": { "channel_codes": [ "US" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] }, "available_end_date": "2019-09-29T22:00:00Z", "available_start_date": "2019-03-31T22:00:00Z", "category_code": "3016100", "category_label": "Shoes", "channels": [ "FR", "US" ], "currency_iso_code": "USD", "description": "Offer description", "discount": { "discount_price": null, "end_date": "2019-04-29T22:00:00Z", "origin_price": 50, "ranges": [ { "price": 49, "quantity_threshold": 1 }, { "price": 44, "quantity_threshold": 50 }, { "price": 39, "quantity_threshold": 100 } ], "start_date": "2019-03-31T22:00:00Z" }, "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "fulfillment": { "center": { "code": "FULFILLMENT_CENTER_CODE" } }, "inactivity_reasons": [ "SHOP_NOT_OPEN", "ZERO_QUANTITY" ], "leadtime_to_ship": 10, "logistic_class": { "code": "M", "label": "Medium" }, "min_order_quantity": 1, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "offer_additional_fields": [ { "code": "ecotax", "type": "NUMERIC", "value": "20" }, { "code": "gift-wrap", "type": "BOOLEAN", "value": "true" }, { "code": "min-quantity-ordered", "type": "NUMERIC", "value": "5" } ], "offer_id": 2135, "package_quantity": 1, "price": 49, "price_additional_info": "Apply Discount prices", "product_brand": "Capture", "product_description": "Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.", "product_references": [ { "reference": "9400016774345", "reference_type": "EAN" } ], "product_sku": "MKP100000000154824", "product_title": "Capture Coloured Court Shoe - 10", "quantity": 1000000, "shipping_deadline": "2019-09-01T23:59:59.999Z", "shop_sku": "S2002", "state_code": "11", "total_price": 49, "warehouses": [ { "code": "WAREHOUSE_001", "quantity": 750000 }, { "code": "WAREHOUSE_002", "quantity": 250000 } ] } ], "total_count": 1 } }, "application/json-1": { "summary": "Example with business values for multi channel pricing users (application/json)", "value": { "offers": [ { "active": true, "all_prices": [ { "channel_code": null, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 49, "unit_discount_price": 49, "unit_origin_price": 50, "volume_prices": [ { "price": 49, "quantity_threshold": 1, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 50, "unit_discount_price": 44, "unit_origin_price": 45 }, { "price": 39, "quantity_threshold": 100, "unit_discount_price": 39, "unit_origin_price": 40 } ] }, { "channel_code": null, "context": { "channel_codes": [ "US" ] }, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 59, "unit_discount_price": 59, "unit_origin_price": 60, "volume_prices": [ { "price": 59, "quantity_threshold": 1, "unit_discount_price": 59, "unit_origin_price": 60 }, { "price": 49, "quantity_threshold": 50, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 100, "unit_discount_price": 44, "unit_origin_price": 45 } ] }, { "channel_code": null, "context": { "channel_codes": [ "US", "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] } ], "allow_quote_requests": false, "applicable_pricing": { "channel_code": null, "context": { "channel_codes": [ "US", "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] }, "available_end_date": "2019-09-29T22:00:00Z", "available_start_date": "2019-03-31T22:00:00Z", "category_code": "3016100", "category_label": "Shoes", "channels": [ "FR", "US" ], "currency_iso_code": "USD", "description": "Offer description", "discount": { "discount_price": null, "end_date": "2019-04-29T22:00:00Z", "origin_price": 50, "ranges": [ { "price": 49, "quantity_threshold": 1 }, { "price": 44, "quantity_threshold": 50 }, { "price": 39, "quantity_threshold": 100 } ], "start_date": "2019-03-31T22:00:00Z" }, "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "fulfillment": { "center": { "code": "FULFILLMENT_CENTER_CODE" } }, "inactivity_reasons": [ "SHOP_NOT_OPEN", "ZERO_QUANTITY" ], "leadtime_to_ship": 10, "logistic_class": { "code": "M", "label": "Medium" }, "min_order_quantity": 1, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "offer_additional_fields": [ { "code": "ecotax", "type": "NUMERIC", "value": "20" }, { "code": "gift-wrap", "type": "BOOLEAN", "value": "true" }, { "code": "min-quantity-ordered", "type": "NUMERIC", "value": "5" } ], "offer_id": 2135, "package_quantity": 1, "price": 49, "price_additional_info": "Apply Discount prices", "product_brand": "Capture", "product_description": "Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.", "product_references": [ { "reference": "9400016774345", "reference_type": "EAN" } ], "product_sku": "MKP100000000154824", "product_title": "Capture Coloured Court Shoe - 10", "quantity": 1000000, "shipping_deadline": "2019-09-01T23:59:59.999Z", "shop_sku": "S2002", "state_code": "11", "total_price": 49, "warehouses": [ { "code": "WAREHOUSE_001", "quantity": 750000 }, { "code": "WAREHOUSE_002", "quantity": 250000 } ] } ], "total_count": 1 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "offers": [ { "active": true, "all_prices": [ { "channel_code": "string", "context": { "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "start_date": "2023-03-28T09:34:42Z" }, "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "price": 0, "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] } ], "allow_quote_requests": true, "applicable_pricing": { "channel_code": "string", "context": { "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "start_date": "2023-03-28T09:34:42Z" }, "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "price": 0, "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] }, "available_end_date": "2023-03-28T09:34:42Z", "available_start_date": "2023-03-28T09:34:42Z", "category_code": "string", "category_label": "string", "channels": [ "string" ], "currency_iso_code": "AED", "description": "string", "discount": { "discount_price": 0, "end_date": "2023-03-28T09:34:42Z", "origin_price": 0, "ranges": [ { "price": 0, "quantity_threshold": 0 } ], "start_date": "2023-03-28T09:34:42Z" }, "eco_contributions": [ { "eco_contribution_amount": 0, "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "favorite_rank": 0, "fulfillment": { "center": { "code": "string" } }, "inactivity_reasons": [ "PRODUCT_STATUS_NEW" ], "internal_description": "string", "leadtime_to_ship": 0, "logistic_class": { "code": "string", "label": "string" }, "max_order_quantity": 0, "min_order_quantity": 0, "min_quantity_alert": 0, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "string", "min_shipping_zone": "string", "msrp": 0, "offer_additional_fields": [ { "code": "string", "type": "STRING" } ], "offer_id": 0, "package_quantity": 0, "price": 0, "price_additional_info": "string", "product_brand": "string", "product_description": "string", "product_references": [ { "reference": "string", "reference_type": "string" } ], "product_sku": "string", "product_tax_code": "string", "product_title": "string", "quantity": 0, "retail_prices": [ { "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ], "shipping_deadline": "2023-03-28T09:34:42Z", "shop_sku": "string", "state_code": "string", "total_price": 0, "warehouses": [ { "code": "string", "quantity": 0 } ] } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF21_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_READ" ] } ], "summary": "OF21 - List offers of a shop", "tags": [ "Offers" ] }, "post": { "description": "
    Description
    \n\n

    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.

    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "offers": [ { "all_prices": [ { "channel_code": "US", "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-04-01T22:00:00Z", "unit_discount_price": "49", "unit_origin_price": 50, "volume_prices": [ { "quantity_threshold": 5, "unit_discount_price": 45, "unit_origin_price": 48 } ] } ], "allow_quote_requests": false, "available_ended": "2019-05-29T22:00:00Z", "available_started": "2019-03-01T22:00:00Z", "description": "Offer for product MKP100000000154824", "discount": { "end_date": "2019-05-31T22:00:00Z", "price": 49, "ranges": [ { "price": 45, "quantity_threshold": 5 } ], "start_date": "2019-03-31T22:00:00Z" }, "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "internal_description": "Offer for product MKP100000000154824", "leadtime_to_ship": 5, "logistic_class": "M", "max_order_quantity": 3, "min_order_quantity": 1, "min_quantity_alert": 2, "offer_additional_fields": [ { "code": "ecotax", "value": "20" } ], "package_quantity": "2", "price": 50, "price_additional_info": "Apply Discount prices", "product_id": "9400016774345", "product_id_type": "EAN", "product_tax_code": "tax", "quantity": "5000", "shop_sku": "Offer_SKU_001", "state_code": "11", "update_delete": "update" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "offers": [ { "all_prices": [ { "channel_code": "string", "discount_end_date": "string", "discount_start_date": "string", "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] } ], "allow_quote_requests": true, "available_ended": "string", "available_started": "string", "description": "string", "discount": { "end_date": "string", "price": 0, "ranges": [ { "price": 0, "quantity_threshold": 0 } ], "start_date": "string" }, "eco_contributions": [ { "eco_contribution_amount": 0, "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "internal_description": "string", "leadtime_to_ship": 0, "logistic_class": "string", "max_order_quantity": 0, "min_order_quantity": 0, "min_quantity_alert": 0, "msrp": 0, "offer_additional_fields": [ { "code": "string", "type": "STRING" } ], "package_quantity": 0, "price": 0, "price_additional_info": "string", "pricing_unit": "string", "product_id": "string", "product_id_type": "string", "product_tax_code": "string", "quantity": 0, "retail_prices": [ { "discount_end_date": "string", "discount_start_date": "string", "unit_discount_price": 0, "unit_origin_price": 0 } ], "shop_sku": "string", "state_code": "string", "update_delete": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/OF24_Request" } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "import_id": 2044 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "import_id": 0 } } }, "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": "OF24 - Create, update, or delete offers", "tags": [ "Offers" ] } }, "/api/offers/{offer}": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each offer page display
    \n
    Maximum usage: At each offer page display
    \n
    Read More
    \n\n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values for single channel pricing users (application/json)", "value": { "active": true, "all_prices": [ { "channel_code": null, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 49, "unit_discount_price": 49, "unit_origin_price": 50, "volume_prices": [ { "price": 49, "quantity_threshold": 1, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 50, "unit_discount_price": 44, "unit_origin_price": 45 }, { "price": 39, "quantity_threshold": 100, "unit_discount_price": 39, "unit_origin_price": 40 } ] }, { "channel_code": "US", "context": { "channel_codes": [ "US" ] }, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 59, "unit_discount_price": 59, "unit_origin_price": 60, "volume_prices": [ { "price": 59, "quantity_threshold": 1, "unit_discount_price": 59, "unit_origin_price": 60 }, { "price": 49, "quantity_threshold": 50, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 100, "unit_discount_price": 44, "unit_origin_price": 45 } ] }, { "channel_code": "US", "context": { "channel_codes": [ "US" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] } ], "allow_quote_requests": false, "applicable_pricing": { "channel_code": "US", "context": { "channel_codes": [ "US" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] }, "available_end_date": "2019-09-29T22:00:00Z", "available_start_date": "2019-03-31T22:00:00Z", "category_code": "3016100", "category_label": "Shoes", "channels": [ "FR", "US" ], "currency_iso_code": "USD", "description": "Offer for product MKP100000000154824", "discount": { "discount_price": null, "end_date": "2019-04-29T22:00:00Z", "origin_price": 50, "ranges": [ { "price": 49, "quantity_threshold": 1 }, { "price": 44, "quantity_threshold": 50 }, { "price": 39, "quantity_threshold": 100 } ], "start_date": "2019-03-31T22:00:00Z" }, "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "fulfillment": { "center": { "code": "DEFAULT" } }, "leadtime_to_ship": 10, "logistic_class": { "code": "M", "label": "Medium" }, "max_order_quantity": 5, "min_order_quantity": 1, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "offer_additional_fields": [ { "code": "ecotax", "type": "NUMERIC", "value": "20" }, { "code": "gift-wrap", "type": "BOOLEAN", "value": "true" }, { "code": "min-quantity-ordered", "type": "NUMERIC", "value": "5" } ], "offer_id": 2135, "package_quantity": 1, "price": 49, "price_additional_info": "Apply Discount prices", "product_brand": "Capture", "product_description": "Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.", "product_references": [ { "reference": "9400016774345", "reference_type": "EAN" } ], "product_sku": "MKP100000000154824", "product_title": "Capture Coloured Court Shoe - 10", "quantity": 1000000, "shipping_deadline": "2019-09-01T23:59:59.999Z", "shop_sku": "S2002", "state_code": "11", "total_price": 49, "warehouses": [ { "code": "WAREHOUSE_001", "quantity": 750000 }, { "code": "WAREHOUSE_002", "quantity": 250000 } ] } }, "application/json-1": { "summary": "Example with business values for multi channel pricing users (application/json)", "value": { "active": true, "all_prices": [ { "channel_code": null, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 49, "unit_discount_price": 49, "unit_origin_price": 50, "volume_prices": [ { "price": 49, "quantity_threshold": 1, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 50, "unit_discount_price": 44, "unit_origin_price": 45 }, { "price": 39, "quantity_threshold": 100, "unit_discount_price": 39, "unit_origin_price": 40 } ] }, { "channel_code": null, "context": { "channel_codes": [ "US" ] }, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-03-31T22:00:00Z", "price": 59, "unit_discount_price": 59, "unit_origin_price": 60, "volume_prices": [ { "price": 59, "quantity_threshold": 1, "unit_discount_price": 59, "unit_origin_price": 60 }, { "price": 49, "quantity_threshold": 50, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 44, "quantity_threshold": 100, "unit_discount_price": 44, "unit_origin_price": 45 } ] }, { "channel_code": null, "context": { "channel_codes": [ "US", "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] } ], "allow_quote_requests": false, "applicable_pricing": { "channel_code": null, "context": { "channel_codes": [ "US", "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] }, "available_end_date": "2019-09-29T22:00:00Z", "available_start_date": "2019-03-31T22:00:00Z", "category_code": "3016100", "category_label": "Shoes", "channels": [ "FR", "US" ], "currency_iso_code": "USD", "description": "Offer for product MKP100000000154824", "discount": { "discount_price": null, "end_date": "2019-04-29T22:00:00Z", "origin_price": 50, "ranges": [ { "price": 49, "quantity_threshold": 1 }, { "price": 44, "quantity_threshold": 50 }, { "price": 39, "quantity_threshold": 100 } ], "start_date": "2019-03-31T22:00:00Z" }, "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "fulfillment": { "center": { "code": "DEFAULT" } }, "leadtime_to_ship": 10, "logistic_class": { "code": "M", "label": "Medium" }, "max_order_quantity": 5, "min_order_quantity": 1, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "offer_additional_fields": [ { "code": "ecotax", "type": "NUMERIC", "value": "20" }, { "code": "gift-wrap", "type": "BOOLEAN", "value": "true" }, { "code": "min-quantity-ordered", "type": "NUMERIC", "value": "5" } ], "offer_id": 2135, "package_quantity": 1, "price": 49, "price_additional_info": "Apply Discount prices", "product_brand": "Capture", "product_description": "Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.", "product_references": [ { "reference": "9400016774345", "reference_type": "EAN" } ], "product_sku": "MKP100000000154824", "product_title": "Capture Coloured Court Shoe - 10", "quantity": 1000000, "shipping_deadline": "2019-09-01T23:59:59.999Z", "shop_sku": "S2002", "state_code": "11", "total_price": 49, "warehouses": [ { "code": "WAREHOUSE_001", "quantity": 750000 }, { "code": "WAREHOUSE_002", "quantity": 250000 } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "active": true, "all_prices": [ { "channel_code": "string", "context": { "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "start_date": "2023-03-28T09:34:42Z" }, "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "price": 0, "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] } ], "allow_quote_requests": true, "applicable_pricing": { "channel_code": "string", "context": { "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "start_date": "2023-03-28T09:34:42Z" }, "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "price": 0, "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] }, "available_end_date": "2023-03-28T09:34:42Z", "available_start_date": "2023-03-28T09:34:42Z", "category_code": "string", "category_label": "string", "channels": [ "string" ], "currency_iso_code": "AED", "description": "string", "discount": { "discount_price": 0, "end_date": "2023-03-28T09:34:42Z", "origin_price": 0, "ranges": [ { "price": 0, "quantity_threshold": 0 } ], "start_date": "2023-03-28T09:34:42Z" }, "eco_contributions": [ { "eco_contribution_amount": 0, "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "favorite_rank": 0, "fulfillment": { "center": { "code": "string" } }, "inactivity_reasons": [ "PRODUCT_STATUS_NEW" ], "internal_description": "string", "leadtime_to_ship": 0, "logistic_class": { "code": "string", "label": "string" }, "max_order_quantity": 0, "min_order_quantity": 0, "min_quantity_alert": 0, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "string", "min_shipping_zone": "string", "msrp": 0, "offer_additional_fields": [ { "code": "string", "type": "STRING" } ], "offer_id": 0, "package_quantity": 0, "price": 0, "price_additional_info": "string", "product_brand": "string", "product_description": "string", "product_references": [ { "reference": "string", "reference_type": "string" } ], "product_sku": "string", "product_tax_code": "string", "product_title": "string", "quantity": 0, "retail_prices": [ { "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ], "shipping_deadline": "2023-03-28T09:34:42Z", "shop_sku": "string", "state_code": "string", "total_price": 0, "warehouses": [ { "code": "string", "quantity": 0 } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF22_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_READ" ] } ], "summary": "OF22 - Get information about an offer", "tags": [ "Offers" ] } }, "/api/offers/{offer}/quantity": { "get": { "deprecated": true, "description": "
    Description
    \n\n

    Quantity return rules:

    • 0: if quantity = 0 or the offer is not available
    • x: quantity available

    \n\n
    \n
    ", "operationId": "OF26", "parameters": [ { "description": "Offer ID", "explode": false, "in": "path", "name": "offer", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "offer_id": 2087, "quantity": 7 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "offer_id": 0, "quantity": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF26_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "OF26 - Get the quantity of stock available for an offer.", "tags": [ "Offers" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/offers/export": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in a future update, please use APIs OF52, OF53, and OF54 instead.\n\n
    Description
    \n\nGet a CSV file that includes the offers updated and deleted since the last request date.
    For deleted offers, only offer-id, product-sku, shop-id, shop-sku, active and deleted columns are returned.
    If the last_request_date param is not set the api returns all the active offers (inactive offers can be included with include_inactive_offers parameter).
    If offers have custom fields, a column is added for each existing custom field with as header the code of the custom field.

    Results are sorted by offer identifier.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage:
    - Differential: every 5 minutes
    - Full: once per day
    \n
    Maximum usage:
    - Differential: once per minute
    - Full: once per day
    \n
    ", "operationId": "OF51", "parameters": [ { "description": "Date and time of your last request.
    If provided, retrieves all offers updated since this date and time, including deleted and inactive offers.
    If not provided, retrieves all active offers only, unless otherwise specified in the include_inactive_offers field.", "explode": true, "in": "query", "name": "last_request_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "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", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "List of the shipping zones codes to filter with, URL-encoded and using a comma (,) as a separator. If specified, only shipping information linked to the given zones will be returned. Otherwise, all shipping information for all zones will be returned.", "explode": true, "in": "query", "name": "shipping_zones", "required": false, "schema": { "type": "string" }, "style": "form" }, { "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.
    When calling the API in differential mode (i.e. when the last_request_date is provided), both active and inactive offers are returned. This field cannot be used in differential mode otherwise the call fails.", "explode": true, "in": "query", "name": "include_inactive_offers", "required": false, "schema": { "type": "boolean", "default": false }, "style": "form" }, { "description": "List of the fields to include, URL-encoded and using a comma (,) as a separator. If specified, only listed fields will be returned.", "explode": true, "in": "query", "name": "include_fields", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "text/csv": { "examples": { "text/csv-0": { "summary": "Example with business values (text/csv)", "value": "offer-id;product-sku;min-shipping-price;min-shipping-price-additional;min-shipping-zone;min-shipping-type;price;total-price;price-additional-info;quantity;description;state-code;shop-id;shop-name;professional;premium;logistic-class;active;favorite-rank;channels;deleted;origin-price;discount-start-date;discount-end-date;available-start-date;available-end-date;discount-price;currency-iso-code;discount-ranges;leadtime-to-ship;allow-quote-requests;price-ranges;fulfillment-center-code;shop-sku;date-created;last-updated;model;min-order-quantity;max-order-quantity;package-quantity;price[channel=CA];origin-price[channel=CA];discount-start-date[channel=CA];discount-end-date[channel=CA];discount-price[channel=CA];discount-ranges[channel=CA];price-ranges[channel=CA];price[channel=FR];origin-price[channel=FR];discount-start-date[channel=FR];discount-end-date[channel=FR];discount-price[channel=FR];discount-ranges[channel=FR];price-ranges[channel=FR];price[channel=BFR];origin-price[channel=BFR];discount-start-date[channel=BFR];discount-end-date[channel=BFR];discount-price[channel=BFR];discount-ranges[channel=BFR];price-ranges[channel=BFR];price[channel=CHR];origin-price[channel=CHR];discount-start-date[channel=CHR];discount-end-date[channel=CHR];discount-price[channel=CHR];discount-ranges[channel=CHR];price-ranges[channel=CHR];price[channel=US];origin-price[channel=US];discount-start-date[channel=US];discount-end-date[channel=US];discount-price[channel=US];discount-ranges[channel=US];price-ranges[channel=US];ecotax;gift-wrap;min-quantity-ordered;measurement-units;producer-id[FR-DEA];eco-contribution-amount[FR-DEA];producer-id[DE-WEEE];eco-contribution-amount[DE-WEEE]\n2130;MKP100000000037254;0.00;0.00;DOM1;CLC;50.00;50.00;;40;;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;;;;;;USD;;;false;1|50.00;DEFAULT;sku-2130;2019-03-31T22:00:00Z;2024-01-07T08:52:10Z;MARKETPLACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kg|1.00000000,L|1.00000000;FR123456_89ABCD;3.59;ProducerID1;0.99\n2131;MKP100000000025008;0.00;0.00;DOM1;CLC;50.00;50.00;;20;;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;;;;;;USD;;;false;1|50.00;DEFAULT;sku-2130;2019-03-31T22:00:00Z;2024-01-07T08:52:10Z;MARKETPLACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;FR123456_89ABCD;3.59;ProducerID1;0.99\n2135;MKP100000000154824;0.00;0.00;DOM1;CLC;49.00;49.00;Apply Discount prices;1000000;Offer description;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;2019-03-31T22:00:00Z;2019-04-29T22:00:00Z;2019-03-31T22:00:00Z;2019-09-29T22:00:00Z;;USD;1|49.00,50|44.00,100|39.00;10;false;1|50.00,50|45.00,100|40.00;DEFAULT;sku-2130;2019-03-31T22:00:00Z;2024-01-07T08:52:10Z;DROPSHIP;1;5;1;;;;;;;;59.00;60.00;2019-03-31T22:00:00Z;2019-04-29T22:00:00Z;;1|59.00,50|49.00,100|44.00;1|60.00,50|50.00,100|45.00;;;;;;;;;;;;;;;;;;;;;;20;true;5;;FR123456_89ABCD;3.59;ProducerID1;0.99\n2136;MKP100000000154824;0.00;0.00;DOM1;CLC;49.00;49.00;Apply Discount prices;5000;Offer for product MKP100000000154824;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;2019-03-31T22:00:00Z;2019-05-31T22:00:00Z;2019-03-01T22:00:00Z;2019-05-29T22:00:00Z;;USD;1|49.00,5|45.00;5;true;1|50.00;DEFAULT;sku-2130;2019-03-31T22:00:00Z;2024-01-07T08:52:10Z;DROPSHIP;2;3;2;;;;;;;;;;;;;;;;;;;;;;;;;;;;;49.00;49.00;2019-04-01T22:00:00Z;2019-04-29T22:00:00Z;;50|45.00;1|49.00,50|48.00;20;;;;FR123456_89ABCD;3.59;ProducerID1;0.99\n" }, "text/csv-1": { "summary": "Example with business values (text/csv) with shipping charges and delivery times", "value": "offer-id;...;shipping-price[zone=DOM1,method=STD];delivery-time-earliest-days[zone=DOM1,method=STD];delivery-time-latest-days[zone=DOM1,method=STD]\n2130;...;10.00;1;2\n2131;...;15.00;;\n" }, "text/csv-auto": { "summary": "Complete example with value types (text/csv)", "value": "string" } }, "schema": { "type": "array", "format": "binary", "items": { "$ref": "#/components/schemas/OF51_Response_200_TextCsv_Ext_FileStructure" } } } }, "description": "OK\n\n> **text/csv**\n>\n>
    \n> The offer custom fields are not listed here. Each custom field will have its own column in the CSV file, with the custom field code as the column name.
    " } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_OFFER_READ", "ROLE_SHOP_ADMIN" ] } ], "summary": "OF51 - Get offers CSV file", "tags": [ "Offers" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/offers/export/async": { "post": { "description": "
    Description
    \n\nExport status and files links can be retrieved by calling OF53.
    Get a CSV or JSON file that includes the offers updated and deleted since the last request date.

    \n
    \nTo ease testing processes, the minimum values for \"megabytes_per_chunk\" and \"items_per_chunk\" have been lowered on TEST and DEV environments.
    \nPlease adapt these values on PROD environments.\n
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage:
    - Differential: every 5 minutes
    - Full: once per day
    \n
    Maximum usage:
    - Differential: once per minute
    - Full: once per day
    \n
    ", "operationId": "OF52", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example of an asynchronous offer CSV export request with business values (application/json)", "value": { "channel_codes": [ "B2B" ], "export_type": "text/csv", "include_fields": [ "active", "allow-quote-requests", "available-end-date", "available-start-date", "channels", "currency-iso-code", "date-created", "deleted", "description", "discount-end-date", "discount-price", "discount-ranges", "discount-start-date", "favorite-rank", "fulfillment-center-code", "leadtime-to-ship", "logistic-class", "measurement-units", "min-shipping-price", "min-shipping-price-additional", "min-shipping-type", "min-shipping-zone", "offer-id", "origin-price", "premium", "price", "price[channel=B2B]", "price-additional-info", "price-ranges", "product-sku", "professional", "quantity", "shop-id", "shop-name", "shop-sku", "state-code", "total-price", "ongoing-discount-campaigns" ], "items_per_chunk": 10000, "last_request_date": "2021-11-12T02:34:00Z", "megabytes_per_chunk": 100, "ongoing_discount_campaign_identifiers": [ "1_JANUARY_PROMOTION_CAMPAIGN", "2_FEBRUARY_PROMOTION_CAMPAIGN" ], "rename_fields": { "active": "active", "allow-quote-requests": "allowQuoteRequests", "available-end-date": "availableEndDate", "available-start-date": "availableStartDate", "channels": "channels", "currency-iso-code": "currencyIsoCode", "date-created": "dateCreated", "deleted": "deleted", "description": "description", "discount-end-date": "discountEndDate", "discount-price": "discountPrice", "discount-ranges": "discountRanges", "discount-start-date": "discountStartDate", "favorite-rank": "favoriteRank", "fulfillment-center-code": "fulfillmentCenterCode", "leadtime-to-ship": "leadtimeToShip", "logistic-class": "logisticClass", "measurement-units": "measurementUnits", "min-shipping-price": "minShippingPrice", "min-shipping-price-additional": "minShippingPriceAdditional", "min-shipping-type": "minShippingType", "min-shipping-zone": "minShippingZone", "offer-id": "offerId", "ongoing-discount-campaigns": "ongoingDiscountCampaigns", "origin-price": "originPrice", "premium": "premium", "price": "price", "price-additional-info": "priceAdditionalinfo", "price-ranges": "priceRanges", "product-sku": "productSku", "professional": "professional", "quantity": "quantity", "shop-id": "shopId", "shop-name": "shopName", "state-code": "stateCode", "total-price": "totalPrice" }, "shipping_zones": [ "DOM1" ] } }, "application/json-1": { "summary": "Example of an asynchronous offer JSON export request with business values (application/json)", "value": { "channel_codes": [ "B2B" ], "export_type": "application/json", "include_fields": [ "active", "allow_quote_requests", "available_end_date", "available_start_date", "channels", "currency_iso_code", "date_created", "deleted", "description", "favorite_rank", "fulfillment", "is_professional", "leadtime_to_ship", "logistic_class", "measurement_units", "min_shipping_price", "min_shipping_price_additional", "offer_id", "ongoing_discount_campaigns", "premium", "prices", "price_additional_info", "product_sku", "quantity", "shipping_types", "shop_id", "shop_name", "shop_sku", "state_code", "eco_contributions" ], "items_per_chunk": 10000, "last_request_date": "2021-11-12T02:34:00Z", "megabytes_per_chunk": 100, "ongoing_discount_campaign_identifiers": [ "1_JANUARY_PROMOTION_CAMPAIGN", "2_FEBRUARY_PROMOTION_CAMPAIGN" ], "shipping_zones": [ "DOM1" ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "channel_codes": [ "string" ], "export_type": "text/csv", "include_fields": [ "string" ], "include_inactive_offers": true, "items_per_chunk": 0, "last_request_date": "2023-03-28T09:34:42Z", "megabytes_per_chunk": 0, "ongoing_discount_campaign_identifiers": [ "string" ], "rename_fields": "object", "shipping_zones": [ "string" ] } } }, "schema": { "$ref": "#/components/schemas/OF52_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example of an asynchronous offer export response with business values (application/json)", "value": { "tracking_id": "760a9a3a-1a3a-4f0d-93a5-cef772c7c3e5" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "tracking_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF52_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_OFFER_READ", "ROLE_SHOP_ADMIN" ] } ], "summary": "OF52 - Export offers CSV or JSON file asynchronously", "tags": [ "Offers" ] } }, "/api/offers/export/async/status/{tracking_id}": { "get": { "description": "
    Description
    \n\nRetrieve the status for an OF52 offer export.
    \nWhen the export is complete, the URLs to retrieve the files are returned.\n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per minute until you get an error or a success
    \n
    Maximum usage: Every 10 seconds
    \n
    ", "operationId": "OF53", "parameters": [ { "description": "The asynchronous offer export id", "explode": false, "in": "path", "name": "tracking_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example of a pending export with business values (application/json)", "value": { "last_updated": "2021-09-23T08:14:06.095Z", "status": "PENDING" } }, "application/json-1": { "summary": "Example of a failed export with business values (application/json)", "value": { "error": { "code": "1", "detail": "Internal error" }, "last_updated": "2021-09-23T08:14:06.095Z", "status": "FAILED" } }, "application/json-2": { "summary": "Example of a completed CSV export with business values (application/json)", "value": { "last_updated": "2021-09-15T08:52:30.348Z", "status": "COMPLETED", "urls": [ "http://your-mirakl-tenant.mirakl.net/api/offers/export/async/file/5715f797-2adb-43d9-bdc3-4bb9fcc90909?file=of52-export%offers/0.csv", "http://your-mirakl-tenant.mirakl.net/api/offers/export/async/file/5715f797-2adb-43d9-bdc3-4bb9fcc90909?file=of52-export%offers/1.csv", "..." ] } }, "application/json-3": { "summary": "Example of a completed JSON export with business values (application/json)", "value": { "last_updated": "2021-09-15T08:52:30.348Z", "status": "COMPLETED", "urls": [ "http://your-mirakl-tenant.mirakl.net/api/offers/export/async/file/5715f797-2adb-43d9-bdc3-4bb9fcc90909?file=of52-export%offers/0.json", "http://your-mirakl-tenant.mirakl.net/api/offers/export/async/file/5715f797-2adb-43d9-bdc3-4bb9fcc90909?file=of52-export%offers/1.json", "..." ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "error": { "code": "string", "detail": "string" }, "last_updated": "2023-03-28T09:34:42Z", "status": "string", "urls": [ "string" ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF53_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_OFFER_READ", "ROLE_SHOP_ADMIN" ] } ], "summary": "OF53 - Poll the status of an asynchronous offer export (OF52)", "tags": [ "Offers" ] } }, "/dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54": { "get": { "description": "
    Description
    \n\nRetrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete\n\n
    \n
    ", "operationId": "OF54", "parameters": [ { "description": "The asynchronous offer export id", "explode": false, "in": "path", "name": "tracking_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": [ { "active": true, "allow_quote_requests": true, "channels": [ "BFR", "CA", "CHR", "FR", "US" ], "currency_iso_code": "EUR", "deleted": false, "description": "This is description of the offer 1200: \n Cotton flannelette, brushed both sides for extra comfort and warmth. 165gsm. Includes one flat sheet, one fitted sheet, one pillowcase in single and king single sets, and two pillowcases in all other sets.", "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "fulfillment": { "center": { "code": "DEFAULT" } }, "is_professional": false, "last_updated": "2022-03-03T08:52:10Z", "leadtime_to_ship": 10, "logistic_class": { "code": "M" }, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "no_commission": false, "offer_id": 2003, "ongoing_discount_campaigns": [ { "identifier": "discount_campaign_1" } ], "premium": false, "prices": [ { "origin_price": 69.99, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 69.99 } ] }, { "context": { "channel_codes": [ "FR", "CA" ], "end_date": "2022-07-31T23:59:59Z", "start_date": "2022-07-01T00:00:00Z" }, "discount_price": 59, "origin_price": 64.99, "volume_prices": [ { "quantity_threshold": 1, "unit_discount_price": 59, "unit_origin_price": 64.99 } ] }, { "context": { "customer_organization_ids": [ "Organization1", "Organization2", "Organization5" ] }, "origin_price": 55, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 55 } ] }, { "context": { "channel_codes": [ "CA" ], "customer_organization_ids": [ "Organization3" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "origin_price": 56, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 56 } ] }, { "context": { "channel_codes": [ "FR", "CA" ] }, "origin_price": 64.99, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 64.99 } ] }, { "context": { "customer_group_ids": [ "Group1" ] }, "origin_price": 58, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 58 } ] }, { "context": { "channel_codes": [ "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "origin_price": 60, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 60 } ] } ], "product_sku": "MKP100000000193522", "quantity": 56, "shop_id": 3, "shop_name": "* Super Shop", "shop_sku": "sku-2003", "state_code": "4" } ] }, "application/json-1": { "summary": "Example with business values (application/json) with shipping charges and delivery times", "value": [ { "active": true, "allow_quote_requests": true, "channels": [ "BFR", "CA", "CHR", "FR", "US" ], "currency_iso_code": "EUR", "deleted": false, "description": "This is description of the offer 1200: \n Cotton flannelette, brushed both sides for extra comfort and warmth. 165gsm. Includes one flat sheet, one fitted sheet, one pillowcase in single and king single sets, and two pillowcases in all other sets.", "fulfillment": { "center": { "code": "DEFAULT" } }, "is_professional": false, "last_updated": "2022-03-03T08:52:10Z", "leadtime_to_ship": 10, "logistic_class": { "code": "M" }, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "no_commission": false, "offer_id": 2003, "premium": false, "prices": [ { "origin_price": 69.99, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 69.99 } ] }, { "context": { "channel_codes": [ "FR", "CA" ], "end_date": "2022-07-31T23:59:59Z", "start_date": "2022-07-01T00:00:00Z" }, "discount_price": 59, "origin_price": 64.99, "volume_prices": [ { "quantity_threshold": 1, "unit_discount_price": 59, "unit_origin_price": 64.99 } ] }, { "context": { "customer_organization_ids": [ "Organization1", "Organization2", "Organization5" ] }, "origin_price": 55, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 55 } ] }, { "context": { "channel_codes": [ "CA" ], "customer_organization_ids": [ "Organization3" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "origin_price": 56, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 56 } ] }, { "context": { "channel_codes": [ "FR", "CA" ] }, "origin_price": 64.99, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 64.99 } ] }, { "context": { "customer_group_ids": [ "Group1" ] }, "origin_price": 58, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 58 } ] }, { "context": { "channel_codes": [ "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "origin_price": 60, "volume_prices": [ { "quantity_threshold": 1, "unit_origin_price": 60 } ] } ], "product_sku": "MKP100000000193522", "quantity": 56, "shipping_types": [ { "code": "STD", "delivery_time": { "earliest_days": 1, "latest_days": 2 }, "shipping_price_additional_unit": 1.5, "shipping_price_unit": 7.5, "shipping_zone_code": "DOM1" }, { "code": "STD", "shipping_price_additional_unit": 3.5, "shipping_price_unit": 17.5, "shipping_zone_code": "INT1" }, { "code": "STD", "shipping_price_additional_unit": 3.5, "shipping_price_unit": 17.5, "shipping_zone_code": "INT2" }, { "code": "STD", "shipping_price_additional_unit": 3.5, "shipping_price_unit": 17.5, "shipping_zone_code": "INT3" } ], "shop_id": 3, "shop_name": "* Super Shop", "shop_sku": "sku-2003", "state_code": "4" } ] }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": "string" } }, "schema": { "type": "object", "format": "binary", "$ref": "#/components/schemas/OF54_Response_200_Ext_FileStructure" } }, "text/csv": { "examples": { "text/csv-2": { "summary": "Example with business values (text/csv)", "value": "offer-id;product-sku;min-shipping-price;min-shipping-price-additional;min-shipping-zone;min-shipping-type;price;total-price;price-additional-info;quantity;description;state-code;shop-id;shop-name;professional;premium;logistic-class;active;favorite-rank;channels;deleted;origin-price;discount-start-date;discount-end-date;available-start-date;available-end-date;discount-price;currency-iso-code;discount-ranges;leadtime-to-ship;allow-quote-requests;price-ranges;fulfillment-center-code;shop-sku;date-created;last-updated;model;min-order-quantity;max-order-quantity;package-quantity;price[channel=CA];origin-price[channel=CA];discount-start-date[channel=CA];discount-end-date[channel=CA];discount-price[channel=CA];discount-ranges[channel=CA];price-ranges[channel=CA];price[channel=FR];origin-price[channel=FR];discount-start-date[channel=FR];discount-end-date[channel=FR];discount-price[channel=FR];discount-ranges[channel=FR];price-ranges[channel=FR];price[channel=BFR];origin-price[channel=BFR];discount-start-date[channel=BFR];discount-end-date[channel=BFR];discount-price[channel=BFR];discount-ranges[channel=BFR];price-ranges[channel=BFR];price[channel=CHR];origin-price[channel=CHR];discount-start-date[channel=CHR];discount-end-date[channel=CHR];discount-price[channel=CHR];discount-ranges[channel=CHR];price-ranges[channel=CHR];price[channel=US];origin-price[channel=US];discount-start-date[channel=US];discount-end-date[channel=US];discount-price[channel=US];discount-ranges[channel=US];price-ranges[channel=US];ecotax;gift-wrap;min-quantity-ordered;ongoing-discount-campaigns;measurement-units;producer-id[FR-DEA];eco-contribution-amount[FR-DEA];producer-id[DE-WEEE];eco-contribution-amount[DE-WEEE]\n2130;MKP100000000037254;0.00;0.00;DOM1;CLC;50.00;50.00;;40;;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;;;;;;USD;;;false;1|50.00;DEFAULT;sku-2130;2023-01-01T12:00:00Z;2023-01-01T12:00:00Z;MARKETPLACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;campaign1;kg|1.00000000,L|1.00000000;FR123456_89ABCD;3.59;ProducerID1;0.99\n2131;MKP100000000025008;0.00;0.00;DOM1;CLC;50.00;50.00;;20;;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;;;;;;USD;;;false;1|50.00;DEFAULT;sku-2130;2023-01-01T12:00:00Z;2023-01-01T12:30:00Z;MARKETPLACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;campaign1;;FR123456_89ABCD;3.59;ProducerID1;0.99\n2135;MKP100000000154824;0.00;0.00;DOM1;CLC;49.00;49.00;Apply Discount prices;1000000;Offer description;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;2019-03-31T22:00:00Z;2019-04-29T22:00:00Z;2019-03-31T22:00:00Z;2019-09-29T22:00:00Z;;USD;1|49.00,50|44.00,100|39.00;10;false;1|50.00,50|45.00,100|40.00;DEFAULT;sku-2130;2023-01-01T12:00:00Z;2023-01-02T12:00:00Z;DROPSHIP;1;5;1;;;;;;;;59.00;60.00;2019-03-31T22:00:00Z;2019-04-29T22:00:00Z;;1|59.00,50|49.00,100|44.00;1|60.00,50|50.00,100|45.00;;;;;;;;;;;;;;;;;;;;;;20;true;5;campaign2;;FR123456_89ABCD;3.59;ProducerID1;0.99\n2136;MKP100000000154824;0.00;0.00;DOM1;CLC;49.00;49.00;Apply Discount prices;5000;Offer for product MKP100000000154824;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;2019-03-31T22:00:00Z;2019-05-31T22:00:00Z;2019-03-01T22:00:00Z;2019-05-29T22:00:00Z;;USD;1|49.00,5|45.00;5;true;1|50.00;DEFAULT;sku-2130;2023-01-01T00:00:00Z;2023-01-01T00:00:00Z;DROPSHIP;2;3;2;;;;;;;;;;;;;;;;;;;;;;;;;;;;;49.00;49.00;2019-04-01T22:00:00Z;2019-04-29T22:00:00Z;;50|45.00;1|49.00,50|48.00;20;;;campaign3;;FR123456_89ABCD;3.59;ProducerID1;0.99\n" }, "text/csv-3": { "summary": "Example with business values (text/csv) with shipping charges and delivery times", "value": "offer-id;...;shipping-price[zone=DOM1,method=STD];delivery-time-earliest-days[zone=DOM1,method=STD];delivery-time-latest-days[zone=DOM1,method=STD]\n2130;...;10.00;1;2\n2131;...;15.00;;\n" }, "text/csv-auto": { "summary": "Complete example with value types (text/csv)", "value": "string" } }, "schema": { "type": "array", "format": "binary", "items": { "$ref": "#/components/schemas/OF54_Response_200_TextCsv_Ext_FileStructure" } } } }, "description": "OK\n\n> **text/csv**\n>\n>
    \n> The offer custom fields are not listed in this list.Each custom field will have its own column, with the custom field code as the column name
    " } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_OFFER_READ", "ROLE_SHOP_ADMIN" ] } ], "summary": "OF54 - Retrieve offer files once asynchronous offer export is complete (OF52)", "tags": [ "Offers" ] } }, "/api/offers/states": { "get": { "description": "
    Description
    \n\nSorted by sort index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: 300 per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "OF61", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "offer_states": [ { "code": "4", "label": "Used - Acceptable Condition" }, { "code": "10", "label": "Refurbished" } ], "total_count": 2 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "offer_states": [ { "code": "string", "label": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OF61_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_SETTINGS_READ" ] } ], "summary": "OF61 - List offer conditions", "tags": [ "Platform Settings" ] } }, "/api/orders": { "put": { "description": "
    Description
    \n\n

    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.

    A maximum of 100 orders can be sent at once.

    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each information update of one or multiple orders (for example: to modify the billing address)
    \n
    Maximum usage: Once per minute, 100 orders per call
    \n
    Read More
    \n\n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Updating eco-contributions", "value": { "orders": [ { "order_id": "Order_00014", "order_lines": [ { "eco_contributions": [ { "epr_category_code": "FR-DEEE", "producer_id": "123456789012345", "unit_amount": 1.25 }, { "epr_category_code": "FR-ASL", "producer_id": "FRASLPRODUCERID", "unit_amount": 1.1 } ], "order_line_id": "Order_00014-A-1" } ] } ] } }, "application/json-1": { "summary": "Updating order references", "value": { "orders": [ { "order_id": "Order_00014", "references": { "order_reference_for_seller": "ref_seller" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "orders": [ { "order_id": "string", "order_lines": [ { "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "unit_amount": 0 } ], "order_line_id": "string" } ], "references": { "order_reference_for_seller": "string" } } ] } } }, "schema": { "$ref": "#/components/schemas/OR04_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Response", "value": { "updated_orders": [ { "errors": [], "order_id": "Order_00014", "updated": { "order_lines": [ { "cancelations": [ { "cancelation_id": "2453", "eco_contributions": [ { "epr_category_code": "FR-ASL", "producer_id": "SELLER_PRODUCER_ID", "producer_id_owner": "SELLER", "total_amount": 1.5, "unit_amount": 1.5 } ] } ], "eco_contributions": [ { "epr_category_code": "FR-ASL", "producer_id": "SELLER_PRODUCER_ID", "producer_id_owner": "SELLER", "total_amount": 15, "unit_amount": 1.5 } ], "order_line_id": "Order_00014-1", "refunds": [ { "eco_contributions": [ { "epr_category_code": "FR-ASL", "producer_id": "SELLER_PRODUCER_ID", "producer_id_owner": "SELLER", "total_amount": 3, "unit_amount": 1.5 } ], "refund_id": "1254" } ] } ], "references": { "order_reference_for_seller": "ref_seller" } } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "updated_orders": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "order_id": "string", "updated": { "order_lines": [ { "cancelations": [ { "cancelation_id": "string", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ] } ], "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "order_line_id": "string", "refunds": [ { "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "refund_id": "string" } ] } ], "references": { "order_reference_for_seller": "string" } } } ] } } }, "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": "OR04 - Patch update orders", "tags": [ "Orders" ] }, "get": { "description": "
    Description
    \n\nPagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead.
    \n\n
    \n
    Call Frequency
    \n\n
    Default:
    Recommended usage:
    - Asynchronous: every 5 minutes
    - Synchronous: at each order page display
    \n
    Maximum usage:
    - Asynchronous: once per minute
    - Synchronous: at each order page display
    \n
    External Partner:
    Recommended usage:
    - Asynchronous: every 15 minutes
    - Synchronous: at each order page display
    \n
    Maximum usage:
    - Asynchronous: every 15 minutes
    - Synchronous: at each order page display
    \n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date, and then by order identifier (asc by default)
    \n\n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "OR11", "parameters": [ { "description": "A comma-separated list of order's identifiers", "explode": true, "in": "query", "name": "order_ids", "required": false, "schema": { "type": "string", "maximum": 100 }, "style": "form" }, { "description": "A comma-separated list of order references for customer", "explode": true, "in": "query", "name": "order_references_for_customer", "required": false, "schema": { "type": "string", "maximum": 100 }, "style": "form" }, { "description": "A comma-separated list of order references for seller", "explode": true, "in": "query", "name": "order_references_for_seller", "required": false, "schema": { "type": "string", "maximum": 100 }, "style": "form" }, { "description": "A comma-separated list of order state's codes", "explode": true, "in": "query", "name": "order_state_codes", "required": false, "schema": { "type": "string", "enum": [ "STAGING", "WAITING_ACCEPTANCE", "WAITING_DEBIT", "WAITING_DEBIT_PAYMENT", "SHIPPING", "SHIPPED", "TO_COLLECT", "RECEIVED", "CLOSED", "REFUSED", "CANCELED" ] }, "style": "form" }, { "description": "A comma-separated list of channel codes", "explode": true, "in": "query", "name": "channel_codes", "required": false, "schema": { "type": "string", "maximum": 100 }, "style": "form" }, { "description": "Return only orders without channel. If true, ignore the channel_codes", "explode": true, "in": "query", "name": "only_null_channel", "required": false, "schema": { "type": "boolean", "default": false }, "style": "form" }, { "description": "Start creation date for filtering", "explode": true, "in": "query", "name": "start_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "End creation date for filtering", "explode": true, "in": "query", "name": "end_date", "required": false, "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", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "End update date for filtering", "explode": true, "in": "query", "name": "end_update_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Order paid by customer", "explode": true, "in": "query", "name": "customer_debited", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Payment workflow of an order", "explode": true, "in": "query", "name": "payment_workflow", "required": false, "schema": { "type": "string", "enum": [ "PAY_ON_ACCEPTANCE", "PAY_ON_DELIVERY", "PAY_ON_DUE_DATE", "PAY_ON_SHIPMENT", "NO_CUSTOMER_PAYMENT_CONFIRMATION" ] }, "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", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Code of the fulfillment center", "explode": true, "in": "query", "name": "fulfillment_center_code", "required": false, "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.
    Possible values:
    • 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.
  • If this query parameter is not specified, the default order tax mode of the platform is used.
    • ", "explode": true, "in": "query", "name": "order_tax_mode", "required": false, "schema": { "type": "string", "enum": [ "TAX_INCLUDED", "TAX_EXCLUDED" ] }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "orders": [ { "acceptance_decision_date": "2019-04-02T14:56:01Z", "can_cancel": false, "can_shop_ship": false, "channel": { "code": "US", "label": "Website US" }, "commercial_id": "Order_00010", "created_date": "2019-04-02T14:18:43Z", "currency_iso_code": "USD", "customer": { "accounting_contact": { "customer_id": "Customer_id_003", "firstname": "Thomas", "lastname": "Anderson", "locale": "en_US" }, "billing_address": { "city": "New York City", "civility": "M", "company": "LIMARK Company", "company_2": "Paris branch", "country": "USA", "country_iso_code": "USA", "firstname": "smith", "lastname": "Taylor", "state": "Manhattan", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "civility": "M", "customer_id": "Customer_id_001", "delivery_contact": { "customer_id": "Customer_id_002", "firstname": "Stella", "lastname": "Lettiere", "locale": "en_US" }, "firstname": "Smith", "lastname": "Taylor", "locale": "en_US", "organization": { "address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "identification_number": "982837446", "name": "Limark Company Inc.", "organization_id": "organization_id_001", "tax_identification_number": "96-25472919" }, "shipping_address": { "additional_info": "One article per box", "city": "New York", "civility": "M", "company": "LIMARK Company", "company_2": "Paris branch", "country": "USA", "country_iso_code": "USA", "firstname": "Smith", "lastname": "Taylor", "state": "Manhattan", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" } }, "customer_debited_date": "2019-04-02T14:58:22.460Z", "customer_directly_pays_seller": false, "customer_notification_email": "notification+ec1riop21ju4rfynl0helvzou.e0z0r7cj2@notification.mirakl.net", "delivery_date": { "earliest": "2019-09-02T08:07:22.326Z", "latest": "2019-09-03T08:07:22.326Z" }, "fulfillment": { "center": { "code": "FULFILLMENT_CENTER_CODE" } }, "fully_refunded": false, "has_customer_message": false, "has_incident": false, "has_invoice": false, "invoice_details": { "document_details": [ { "format": "PDF" }, { "format": "cXML" } ], "payment_terms": { "days": 10, "type": "NET" } }, "last_updated_date": "2019-04-02T14:59:58Z", "leadtime_to_ship": 5, "order_additional_fields": [], "order_id": "Order_00010-A", "order_lines": [ { "can_refund": true, "cancelations": [ { "amount": 12.34, "amount_breakdown": { "parts": [ { "amount": 12.34, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "commission_amount": 2.38, "commission_taxes": [], "commission_total_amount": 2.38, "created_date": "2022-08-04T09:37:58Z", "eco_contributions": [], "fees": [ { "amount": 0.35, "code": "fee1" } ], "id": "1122", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0.05 }, "purchase_commission_on_price": 2.12, "purchase_commission_on_shipping": 0.21, "purchase_fee_amount": { "total_amount": 0.3 }, "purchase_price": 10.22, "purchase_shipping_price": 1 }, "quantity": 0, "reason_code": "34", "shipping_amount": 1.23, "shipping_amount_breakdown": { "parts": [ { "amount": 1.23, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "shipping_taxes": [ { "amount": 1.54, "amount_breakdown": { "parts": [ { "amount": 1.54, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": false } ] }, "code": "tax1", "purchase_tax": { "purchase_amount": 1.27, "purchase_rate": 7.5 }, "rate": 17.5 }, { "amount": 1.54, "amount_breakdown": { "parts": [ { "amount": 1.54, "commissionable": false, "debitable_from_customer": true, "payable_to_shop": false } ] }, "code": "tax2", "purchase_tax": { "purchase_amount": 1.27, "purchase_rate": 7.5 }, "rate": 17.5 } ], "taxes": [ { "amount": 0.75, "amount_breakdown": { "parts": [ { "amount": 0.75, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": false } ] }, "code": "tax1", "purchase_tax": { "purchase_amount": 0.62, "purchase_rate": 7.5 }, "rate": 17.5 }, { "amount": 0.75, "amount_breakdown": { "parts": [ { "amount": 0.75, "commissionable": false, "debitable_from_customer": true, "payable_to_shop": false } ] }, "code": "tax2", "purchase_tax": { "purchase_amount": 0.62, "purchase_rate": 7.5 }, "rate": 17.5 } ] } ], "category_code": "5110114", "category_label": "Coffee Machines", "commission_fee": 21.3, "commission_taxes": [ { "amount": 0, "code": "TAXZERO", "rate": 0 } ], "created_date": "2019-04-02T14:18:43Z", "debited_date": "2019-04-02T14:58:22Z", "description": null, "eco_contributions": [ { "epr_category_code": "FR_DEE", "producer_id": "EPR_PRODUCER_ID", "producer_id_owner": "SELLER", "total_amount": 6, "unit_amount": 2 } ], "fees": [ { "amount": 0.65, "code": "fee1" } ], "last_updated_date": "2019-04-02T14:59:58Z", "offer_id": 2130, "offer_sku": "S2000", "offer_state_code": "11", "order_line_additional_fields": [ { "code": "delivery-countries", "type": "MULTIPLE_VALUES_LIST", "value": [ "USA" ] } ], "order_line_id": "Order_00010-A-1", "order_line_index": 1, "order_line_state": "RECEIVED", "order_line_state_reason_code": null, "order_line_state_reason_label": null, "origin_unit_price": 60, "price": 165, "price_additional_info": null, "price_unit": 55, "product_medias": [ { "media_url": "/media/product/image/57b58b2e-8849-4d8d-9072-0aa33d314e5c", "mime_type": "JPEG", "type": "MEDIUM" }, { "media_url": "/media/product/image/8bc8241d-0747-4891-bb2e-881202f5465a", "mime_type": "JPEG", "type": "LARGE" }, { "media_url": "/media/product/image/d3fd1d4e-a943-4df0-8878-3343ba139dd9", "mime_type": "JPEG", "type": "SMALL" } ], "product_shop_sku": "125069", "product_sku": "MKP100000000037254", "product_title": "Breville Cafe Roma Stainless Espresso/Cappuccino Machine - ESP8C", "promotions": [], "purchase_information": { "purchase_commission_on_fees": { "total_amount": 1 }, "purchase_commission_on_price": 25.45, "purchase_commission_on_shipping": 1.12, "purchase_fee_amount": { "total_amount": 1 }, "purchase_price": 127.21, "purchase_shipping_price": 5.65, "purchase_unit_price": 137.39 }, "quantity": 3, "received_date": "2019-04-02T14:59:58Z", "refunds": [ { "amount": 6.82, "commission_amount": 1.69, "commission_tax_amount": 0, "commission_taxes": [ { "amount": 0, "code": "TAXZERO" } ], "commission_total_amount": 1.69, "created_date": "2022-08-04T09:40:41Z", "eco_contributions": [], "fees": [ { "amount": 0.3, "code": "fee1" } ], "id": "1106", "order_refund_id": "f029dc92-e5ae-4b89-b342-cf254ddd4b4d", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0.05 }, "purchase_commission_on_price": 1.34, "purchase_commission_on_shipping": 0.35, "purchase_fee_amount": { "total_amount": 0.3 }, "purchase_price": 5.48, "purchase_shipping_price": 1.44 }, "quantity": 0, "reason_code": "19", "shipping_amount": 1.79, "shipping_taxes": [ { "amount": 2.24, "code": "tax1", "purchase_tax": { "purchase_amount": 1.8, "purchase_rate": 1.5 }, "rate": 17.5 }, { "amount": 2.24, "code": "tax2", "purchase_tax": { "purchase_amount": 1.8, "purchase_rate": 1.5 }, "rate": 17.5 } ], "state": "WAITING_REFUND_PAYMENT", "tax_legal_notice": "Tax Legal Notice", "taxes": [ { "amount": 0.41, "code": "tax1", "purchase_tax": { "purchase_amount": 0.33, "purchase_rate": 1.5 }, "rate": 17.5 }, { "amount": 0.41, "code": "tax2", "purchase_tax": { "purchase_amount": 0.33, "purchase_rate": 1.5 }, "rate": 17.5 } ] } ], "shipped_date": "2019-04-02T14:58:39Z", "shipping_from": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "10E 40th Street", "street_2": "14th floor", "zip_code": "10016" }, "warehouse": null }, "shipping_price": 8, "shipping_taxes": [ { "amount": 10, "code": "tax1", "purchase_tax": { "purchase_amount": 7.06 }, "rate": 17.5 }, { "amount": 10, "code": "tax2", "purchase_tax": { "purchase_amount": 7.06 }, "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" } ], "tax_legal_notice": "Tax Legal Notice", "taxes": [ { "amount": 10, "code": "tax1", "origin_unit_amount": 2, "purchase_tax": { "purchase_amount": 7.71 }, "rate": 17.5, "tax_calculation_rule": "NONE" }, { "amount": 10, "code": "tax2", "origin_unit_amount": 2, "purchase_tax": { "purchase_amount": 7.71 } } ], "total_commission": 21.3, "total_price": 173 } ], "order_state": "RECEIVED", "order_state_reason_code": null, "order_state_reason_label": null, "order_tax_mode": "TAX_EXCLUDED", "order_taxes": [ { "code": "tax1", "rate": 17.5, "total_amount": 40 }, { "code": "tax2", "rate": null, "total_amount": 40 } ], "payment_type": "Visa", "payment_workflow": "PAY_ON_ACCEPTANCE", "price": 165, "promotions": { "applied_promotions": [], "total_deduced_amount": 0 }, "quote_id": null, "references": { "order_reference_for_customer": "ref_customer", "order_reference_for_seller": "ref_seller" }, "shipping_carrier_code": "UPS", "shipping_carrier_standard_code": "UPS", "shipping_company": "UPS", "shipping_deadline": "2019-09-01T23:59:59.999Z", "shipping_price": 8, "shipping_pudo_id": "C1039", "shipping_tracking": "2344", "shipping_tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=2344", "shipping_type_code": "STD", "shipping_type_label": "Standard", "shipping_type_standard_code": "CU_ADD-STD", "shipping_zone_code": "INT1", "shipping_zone_label": "International 1", "total_commission": 21.3, "total_price": 173, "transaction_date": "2019-06-25T07:42:21.215Z", "transaction_number": "TR_MIR-PHHV83UB" } ], "total_count": 1 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "orders": [ { "acceptance_decision_date": "2023-03-28T09:34:42Z", "can_cancel": true, "can_shop_ship": true, "channel": { "code": "string", "label": "string" }, "commercial_id": "string", "created_date": "2023-03-28T09:34:42Z", "currency_iso_code": "AED", "customer": { "accounting_contact": { "civility": "string", "customer_id": "string", "firstname": "string", "lastname": "string", "locale": "string" }, "billing_address": { "city": "string", "civility": "string", "company": "string", "company_2": "string", "country": "string", "country_iso_code": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "civility": "string", "customer_id": "string", "delivery_contact": { "civility": "string", "customer_id": "string", "firstname": "string", "lastname": "string", "locale": "string" }, "firstname": "string", "lastname": "string", "locale": "string", "organization": { "address": { "city": "string", "country_iso_code": "AFG", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "electronic_address": "string", "identification_number": "string", "name": "string", "organization_id": "string", "phone_number": "string", "tax_identification_number": "string" }, "shipping_address": { "additional_info": "string", "city": "string", "civility": "string", "company": "string", "company_2": "string", "country": "string", "country_iso_code": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } }, "customer_debited_date": "2023-03-28T09:34:42Z", "customer_directly_pays_seller": true, "customer_notification_email": "string", "delivery_date": { "earliest": "2023-03-28T09:34:42Z", "latest": "2023-03-28T09:34:42Z" }, "discount_campaigns": [ { "identifier": "string" } ], "fulfillment": { "center": { "code": "string" } }, "fully_refunded": true, "has_customer_message": true, "has_incident": true, "has_invoice": true, "invoice_details": { "document_details": [ { "format": "PDF" } ], "payment_terms": { "days": 0, "type": "END_OF_MONTH" } }, "last_updated_date": "2023-03-28T09:34:42Z", "leadtime_to_ship": 0, "order_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_id": "string", "order_lines": [ { "can_refund": true, "cancelations": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "commission_amount": 0, "commission_taxes": [ { "amount": 0, "code": "string" } ], "commission_total_amount": 0, "created_date": "2023-03-28T09:34:42Z", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "fees": [ { "amount": 0, "code": "string" } ], "id": "string", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0 }, "purchase_commission_on_price": 0, "purchase_commission_on_shipping": 0, "purchase_fee_amount": { "total_amount": 0 }, "purchase_price": 0, "purchase_shipping_price": 0 }, "quantity": 0, "reason_code": "string", "shipping_amount": 0, "shipping_amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "shipping_taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ], "taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ] } ], "category_code": "string", "category_label": "string", "commission_fee": 0, "commission_rate_vat": 0, "commission_taxes": [ { "amount": 0, "code": "string", "rate": 0 } ], "commission_vat": 0, "created_date": "2023-03-28T09:34:42Z", "debited_date": "2023-03-28T09:34:42Z", "description": "string", "discount_campaign": { "identifier": "string" }, "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "fees": [ { "amount": 0, "code": "string" } ], "last_updated_date": "2023-03-28T09:34:42Z", "measurement": { "actual_measurement": 0, "adjustment_limit": 0, "measurement_unit": "GRAM", "ordered_measurement": 0 }, "offer_id": 0, "offer_sku": "string", "offer_state_code": "string", "order_line_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_line_id": "string", "order_line_index": 0, "order_line_state": "STAGING", "order_line_state_reason_code": "string", "order_line_state_reason_label": "string", "origin_unit_price": 0, "price": 0, "price_additional_info": "string", "price_amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "price_unit": 0, "product_medias": [ { "media_url": "string", "mime_type": "string", "type": "string" } ], "product_shop_sku": "string", "product_sku": "string", "product_title": "string", "promotions": [ { "apportioned": true, "campaign": { "identifier": "string" }, "configuration": { "amount_off": 0, "free_items_quantity": 0, "internal_description": "string", "percentage_off": 0, "reduced_unit_price": 0, "type": "ALL" }, "deduced_amount": 0, "id": "string", "offered_quantity": 0, "promo_code": "string" } ], "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0 }, "purchase_commission_on_price": 0, "purchase_commission_on_shipping": 0, "purchase_fee_amount": { "total_amount": 0 }, "purchase_price": 0, "purchase_shipping_price": 0, "purchase_unit_price": 0 }, "quantity": 0, "received_date": "2023-03-28T09:34:42Z", "refunds": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "commission_amount": 0, "commission_tax_amount": 0, "commission_taxes": [ { "amount": 0, "code": "string" } ], "commission_total_amount": 0, "created_date": "2023-03-28T09:34:42Z", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "fees": [ { "amount": 0, "code": "string" } ], "id": "string", "order_refund_id": "string", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0 }, "purchase_commission_on_price": 0, "purchase_commission_on_shipping": 0, "purchase_fee_amount": { "total_amount": 0 }, "purchase_price": 0, "purchase_shipping_price": 0 }, "quantity": 0, "reason_code": "string", "refund_state": "WAITING_REFUND_TAX_CONFIRMATION", "shipping_amount": 0, "shipping_amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "shipping_taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ], "state": "WAITING_REFUND", "tax_legal_notice": "string", "taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ], "transaction_date": "2023-03-28T09:34:42Z", "transaction_number": "string" } ], "shipped_date": "2023-03-28T09:34:42Z", "shipping_from": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "warehouse": { "code": "string" } }, "shipping_price": 0, "shipping_price_additional_unit": 0, "shipping_price_amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "shipping_price_unit": 0, "shipping_taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0, "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" } ], "tax_legal_notice": "string", "taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "origin_unit_amount": 0, "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0, "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" } ], "total_commission": 0, "total_price": 0 } ], "order_refunds": [ { "order_refund_id": "string", "taxes": [ { "code": "string", "rate": 0, "total_amount": 0 } ] } ], "order_state": "STAGING", "order_state_reason_code": "string", "order_state_reason_label": "string", "order_tax_mode": "TAX_INCLUDED", "order_taxes": [ { "code": "string", "rate": 0, "total_amount": 0 } ], "paymentType": "string", "payment_duration": 0, "payment_type": "string", "payment_workflow": "PAY_ON_ACCEPTANCE", "price": 0, "promotions": { "applied_promotions": [ { "apportioned": true, "campaign": { "identifier": "string" }, "configuration": { "amount_off": 0, "free_items_quantity": 0, "internal_description": "string", "percentage_off": 0, "reduced_unit_price": 0, "type": "ALL" }, "deduced_amount": 0, "id": "string", "offered_quantity": 0, "promo_code": "string" } ], "total_deduced_amount": 0 }, "quote_id": "string", "references": { "order_reference_for_customer": "string", "order_reference_for_seller": "string" }, "shipping_carrier_code": "string", "shipping_carrier_standard_code": "string", "shipping_company": "string", "shipping_deadline": "2023-03-28T09:34:42Z", "shipping_price": 0, "shipping_pudo_id": "string", "shipping_tracking": "string", "shipping_tracking_url": "string", "shipping_type_code": "string", "shipping_type_label": "string", "shipping_type_standard_code": "string", "shipping_zone_code": "string", "shipping_zone_label": "string", "total_commission": 0, "total_price": 0, "transaction_date": "2023-03-28T09:34:42Z", "transaction_number": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ" ] } ], "summary": "OR11 - List orders with pagination", "tags": [ "Orders" ] } }, "/api/orders/shipping_from": { "put": { "description": "
    Description
    \n\n

    Update shipping origin (shipping_from) information on order lines.

    A maximum of 100 order lines can be sent at once.

    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each update of shipping origin on one or multiple order lines
    \n
    Maximum usage: 60 per hour, 100 order lines per call
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Update shipping origin with a complete address", "value": { "order_lines": [ { "id": "order-line-1", "shipping_from": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" } } } ] } }, "application/json-1": { "summary": "Update the shipping from country", "value": { "order_lines": [ { "id": "order-line-1", "shipping_from": { "address": { "country_iso_code": "USA" } } } ] } }, "application/json-2": { "summary": "Update the shipping from with a warehouse code", "value": { "order_lines": [ { "id": "order-line-1", "shipping_from": { "warehouse": { "code": "DEFAULT_WAREHOUSE" } } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines": [ { "id": "string", "shipping_from": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "warehouse": { "code": "string" } } } ] } } }, "schema": { "$ref": "#/components/schemas/OR07_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Update shipping origin with a complete address", "value": { "order_lines": [ { "id": "order-line-1", "updated": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "warehouse": null } } ] } }, "application/json-1": { "summary": "Update shipping origin with country", "value": { "order_lines": [ { "id": "order-line-1", "updated": { "address": { "city": null, "country_iso_code": "ESP", "state": null, "street_1": null, "street_2": null, "zip_code": null }, "warehouse": null } } ] } }, "application/json-2": { "summary": "Update shipping origin with a warehouse code", "value": { "order_lines": [ { "id": "order-line-1", "updated": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "warehouse": { "code": "DEFAULT_WAREHOUSE" } } } ] } }, "application/json-3": { "summary": "Update shipping origin with errors", "value": { "order_lines": [ { "errors": [ { "code": "05.read-only", "field": "shipping_from.address", "message": "cannot update shipping_from data once the customer debit workflow has started" } ], "id": "order-line-1" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "id": "string", "updated": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "warehouse": { "code": "string" } } } ] } } }, "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": "OR07 - Update order line shipping origin", "tags": [ "Orders" ] } }, "/api/orders/{order_id}": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in a future update, please use OR11 with the query parameter 'order_ids' instead.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each order page view
    \n
    Maximum usage: On each order page view
    \n
    ", "operationId": "OR12", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "acceptance_decision_date": "2019-04-15T14:29:22Z", "commercial_id": "MIR-YCCYX80B", "created_date": "2019-04-15T14:29:09Z", "customer": { "billing_address": { "city": "New York", "civility": "Ms.", "company": null, "country": "USA", "country_iso_code": "USA", "firstname": "Donna", "lastname": "Ford", "state": "Manhattan", "street_1": "30, Prince Street", "street_2": "1 st floor", "zip_code": "NY 10012" }, "civility": "Ms.", "customer_id": "689-03-2780", "firstname": "Donna", "lastname": "Ford", "shipping_address": { "additional_info": "2nd floor", "city": "New York", "civility": "Ms.", "company": null, "country": "USA", "country_iso_code": null, "firstname": "Donna", "lastname": "Ford", "state": "Manhattan", "street_1": "30, Prince Street", "street_2": "1 st floor", "zip_code": "NY 10012" } }, "has_customer_message": false, "has_incident": false, "has_invoice": false, "last_updated_date": "2019-04-15T14:29:23Z", "order_id": "MIR-YCCYX80B-A", "order_lines": [ { "can_refund": false, "category_code": "5115100", "category_label": "Bed Sheets", "commission_fee": 2.86, "commission_rate_vat": 20, "commission_vat": 0.57, "created_date": "2019-04-15T14:29:09Z", "debited_date": null, "description": "This is description of the offer 1800: \n Cotton flannelette, brushed both sides for extra comfort and warmth. 165gsm. Includes one flat sheet, one fitted sheet, one pillowcase in single and king single sets, and two pillowcases in all other sets.", "last_updated_date": "2019-04-15T14:29:23Z", "offer_id": 2004, "offer_sku": "1800", "offer_state_code": "4", "order_line_additional_fields": [], "order_line_id": "MIR-YCCYX80B-A-1", "order_line_index": 1, "order_line_state": "SHIPPING", "order_line_state_reason_code": null, "order_line_state_reason_label": null, "price": 24, "price_additional_info": null, "price_unit": 12, "product_sku": "MKP100000000193612", "product_title": "Cotton Flannelette Sheet Sets - Super King", "quantity": 2, "received_date": null, "shipped_date": null, "shipping_price": 2, "total_commission": 4, "total_price": 26 }, { "can_refund": false, "category_code": "5115100", "category_label": "Bed Sheets", "commission_fee": 4.29, "commission_rate_vat": 20, "commission_vat": 0.86, "created_date": "2019-04-15T14:29:09Z", "debited_date": null, "description": "This is description of the offer 1900: \n Cotton flannelette, brushed both sides for extra comfort and warmth. 165gsm. Includes one flat sheet, one fitted sheet, one pillowcase in single and king single sets, and two pillowcases in all other sets.", "last_updated_date": "2019-04-15T14:29:23Z", "offer_id": 2005, "offer_sku": "1900", "offer_state_code": "4", "order_line_additional_fields": [], "order_line_id": "MIR-YCCYX80B-A-2", "order_line_index": 2, "order_line_state": "SHIPPING", "order_line_state_reason_code": null, "order_line_state_reason_label": null, "price": 36, "price_additional_info": null, "price_unit": 12, "product_sku": "MKP100000000193674", "product_title": "Cotton Flannelette Sheet Sets - King Single", "quantity": 3, "received_date": null, "shipped_date": null, "shipping_price": 3, "total_commission": 6.01, "total_price": 39 } ], "order_state": "SHIPPING", "order_state_reason_code": null, "order_state_reason_label": null, "payment_type": "Credit Card", "price": 60, "shipping_company": null, "shipping_price": 5, "shipping_tracking": null, "shipping_tracking_url": null, "shipping_type_code": "CLC", "shipping_type_label": "Click & collect", "shipping_zone_code": "DOM1", "shipping_zone_label": "Domestic 1", "total_commission": 10.01, "total_price": 65 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "acceptance_decision_date": "2023-03-28T09:34:42Z", "commercial_id": "string", "created_date": "2023-03-28T09:34:42Z", "customer": { "billing_address": { "city": "string", "civility": "string", "company": "string", "country": "string", "country_iso_code": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "civility": "string", "customer_id": "string", "firstname": "string", "lastname": "string", "shipping_address": { "additional_info": "string", "city": "string", "civility": "string", "company": "string", "country": "string", "country_iso_code": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } }, "has_customer_message": true, "has_incident": true, "has_invoice": true, "last_updated_date": "2023-03-28T09:34:42Z", "order_id": "string", "order_lines": [ { "can_refund": true, "category_code": "string", "category_label": "string", "commission_fee": 0, "commission_rate_vat": 0, "commission_vat": 0, "created_date": "2023-03-28T09:34:42Z", "debited_date": "2023-03-28T09:34:42Z", "description": "string", "last_updated_date": "2023-03-28T09:34:42Z", "offer_id": 0, "offer_sku": "string", "offer_state_code": "string", "order_line_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_line_id": "string", "order_line_index": 0, "order_line_state": "STAGING", "order_line_state_reason_code": "string", "order_line_state_reason_label": "string", "price": 0, "price_additional_info": "string", "price_unit": 0, "product_sku": "string", "product_title": "string", "quantity": 0, "received_date": "2023-03-28T09:34:42Z", "shipped_date": "2023-03-28T09:34:42Z", "shipping_price": 0, "shipping_price_additional_unit": 0, "shipping_price_unit": 0, "total_commission": 0, "total_price": 0 } ], "order_state": "STAGING", "order_state_reason_code": "string", "order_state_reason_label": "string", "paymentType": "string", "payment_type": "string", "price": 0, "shipping_company": "string", "shipping_price": 0, "shipping_tracking": "string", "shipping_tracking_url": "string", "shipping_type_code": "string", "shipping_type_label": "string", "shipping_zone_code": "string", "shipping_zone_label": "string", "total_commission": 0, "total_price": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR12_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "OR12 - Get information about an order", "tags": [ "Orders" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/orders/async-export": { "post": { "description": "
    Description
    \n\n

    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:

    • respect a maximum megabyte weight using the megabytes_per_chunk parameter.
    • respect a maximum amount of exported items using the items_per_chunk parameter.

    Only one export request can be created for the same shop account.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage:
    - Differential: every 15 minutes
    \n
    Maximum usage:
    - Differential: every 5 minutes
    - Full: every 24 hours
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "OR13", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values", "value": { "channel_codes": [ "US" ], "end_date": "2023-01-01T00:00:00.000Z", "end_update_date": "2020-08-19T14:58:22.460Z", "fulfillment_center_codes": "fulfillment_center_codes_001", "items_per_chunk": 10000, "megabytes_per_chunk": 100, "only_null_channel": false, "order_state_codes": [ "WAITING_ACCEPTANCE", "SHIPPING" ], "order_tax_mode": "TAX_INCLUDED", "shop_ids": [ 2310 ], "start_date": "2022-01-01T00:00:00.000Z", "start_update_date": "2019-08-20T14:58:22.460Z" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "channel_codes": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "end_update_date": "2023-03-28T09:34:42Z", "fulfillment_center_codes": "string", "items_per_chunk": 0, "megabytes_per_chunk": 0, "only_null_channel": true, "order_state_codes": [ "STAGING" ], "order_tax_mode": "TAX_INCLUDED", "start_date": "2023-03-28T09:34:42Z", "start_update_date": "2023-03-28T09:34:42Z" } } }, "schema": { "$ref": "#/components/schemas/OR13_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values", "value": { "tracking_id": "tracking_id_001" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "tracking_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR13_Response_200" } } }, "description": "Asynchronous order export tracking creation success" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ" ] } ], "summary": "OR13 - Export orders asynchronously", "tags": [ "Orders" ] } }, "/api/orders/async-export/status/{tracking_id}": { "get": { "description": "
    Description
    \n\n

    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.

    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 10 seconds per OR13 call, until COMPLETED status is received
    \n
    Maximum usage: Every 2 seconds per OR13 call, until COMPLETED status is received
    \n
    ", "operationId": "OR14", "parameters": [ { "description": "Id of the previously created asynchronous order export", "explode": false, "in": "path", "name": "tracking_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "last_updated": "2022-08-18T15:20:22.906Z", "status": "COMPLETED", "urls": [ "http://host:123/api/3f9edb57-9d8b-41e0-8b77-88d90caf7013?file=fileA", "http://host:123/api/3f9edb57-9d8b-41e0-8b77-88d90caf7013?file=fileB" ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "last_updated": "2023-03-28T09:34:42Z", "status": "string", "urls": [ "string" ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR14_Response_200" } } }, "description": "Order asynchronous export tracking polling success" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ" ] } ], "summary": "OR14 - Get the status of an asynchronous order export.", "tags": [ "Orders" ] } }, "/dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15": { "get": { "description": "
    Description
    \n\nRetrieve each chunk of an order export file via the URL generated once the asynchronous export is complete.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per file URL returned by OR14, after COMPLETED status
    \n
    Maximum usage: Once per file URL returned by OR14, after COMPLETED status
    \n
    ", "operationId": "OR15", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": "string" } }, "schema": { "type": "object", "format": "binary", "$ref": "#/components/schemas/OR15_Response_200_Ext_FileStructure" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ" ] } ], "summary": "OR15 - Retrieve order export files once asynchronous export is complete (OR13).", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/accept": { "put": { "description": "
    Description
    \n\nAccept or refuse order lines in the WAITING_ACCEPTANCE status\n\n
    \nError Codes\n\n| Code | Description |\n|------|-------------|\n| ORDER_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\n
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each new order on the Marketplace
    \n
    Maximum usage: At each new order on the Marketplace
    \n
    Read More
    \n\n
    ", "operationId": "OR21", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_lines": [ { "accepted": true, "id": "Order_00012-B-1" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines": [ { "accepted": true, "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/OR21_Request" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_ACCEPT" ] } ], "summary": "OR21 - Accept or refuse order lines", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/tracking": { "put": { "description": "
    Description
    \n\nIf the carrier is not registered, the complete tracking url can be provided.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each order tracking information update (as soon as the seller gets the tracking number from the carrier)
    \n
    Maximum usage: At each order tracking information update (as soon as the seller gets the tracking number from the carrier)
    \n
    ", "operationId": "OR23", "parameters": [ { "description": "Order 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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "carrier_code": "UPS", "carrier_name": "UPS", "carrier_standard_code": "UPS", "carrier_url": "https://ups.com", "tracking_number": "5555" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "carrier_url": "string", "tracking_number": "string" } } }, "schema": { "$ref": "#/components/schemas/OR23_Request" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_TRACKING_WRITE" ] } ], "summary": "OR23 - Update carrier tracking information for a specific order", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/ship": { "put": { "description": "> ⚠️ **Content-length header**\n>\n> The Content-Length header must be present with value 0, even when there is no request body.\n\n
    Description
    \n\nValidate the shipment of an order in the SHIPPING status\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time the tracking number is entered (OR23)
    \n
    Maximum usage: Each time the tracking number is entered (OR23)
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ] } ], "summary": "OR24 - Validate the shipment of an order", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/refund": { "put": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in a future update, please use OR28 instead.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each new refund demand
    \n
    Maximum usage: On each new refund demand
    \n
    ", "operationId": "OR26", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_lines": [ { "id": "MIR-VOE5RDAE-A-1", "reason_code": 15 } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines": [ { "id": "string", "reason_code": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/OR26_Request" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_REFUND" ] } ], "summary": "OR26 - Perform a refund of order lines of an order", "tags": [ "Orders" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/orders/refund": { "put": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each refund request
    \n
    Maximum usage: At each refund request
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_tax_mode": "TAX_EXCLUDED", "refunds": [ { "amount": 1.5, "currency_iso_code": "USD", "excluded_from_shipment": false, "fees": [ { "amount": 0.5, "code": "CARD_FEE" }, { "amount": 0.25, "code": "EU_DRS" } ], "order_line_id": "Order_00010-A-1", "quantity": 0, "reason_code": "15", "shipping_amount": 2, "shipping_taxes": [ { "amount": "1", "code": "tax1" }, { "amount": "1", "code": "tax2" } ], "tax_legal_notice": "Tax legal notice", "taxes": [ { "amount": "1", "code": "tax1" }, { "amount": "1", "code": "tax2" } ] } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_tax_mode": "TAX_INCLUDED", "refunds": [ { "amount": 0, "currency_iso_code": "AED", "excluded_from_shipment": true, "fees": [ { "amount": 0, "code": "string" } ], "order_line_id": "string", "quantity": 0, "reason_code": "string", "shipping_amount": 0, "shipping_taxes": [ { "amount": 0, "code": "string" } ], "taxes": [ { "amount": 0, "code": "string" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/OR28_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_tax_mode": "TAX_EXCLUDED", "refunds": [ { "amount": 1.5, "currency_iso_code": "USD", "eco_contributions": [], "excluded_from_shipment": false, "fees": [ { "amount": 0.5, "code": "CARD_FEE" }, { "amount": 0.25, "code": "EU_DRS" } ], "order_line_id": "Order_00010-A-1", "order_refund_id": "f029dc92-e5ae-4b89-b342-cf254ddd4b4d", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0.05 }, "purchase_commission_on_price": 0.5, "purchase_commission_on_shipping": 1, "purchase_fee_amount": { "total_amount": 0.3 }, "purchase_price": 1, "purchase_shipping_price": 1 }, "quantity": 0, "reason_code": "15", "refund_id": "1130", "shipping_amount": 2, "shipping_taxes": [ { "amount": 1, "code": "tax1", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 }, "rate": 17.5 }, { "amount": 1, "code": "tax2", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 } } ], "tax_legal_notice": "Tax legal notice", "taxes": [ { "amount": 1, "code": "tax1", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 }, "rate": 17.5 }, { "amount": 1, "code": "tax2", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 } } ] } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_tax_mode": "TAX_INCLUDED", "refunds": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "currency_iso_code": "AED", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "excluded_from_shipment": true, "fees": [ { "amount": 0, "code": "string" } ], "order_line_id": "string", "order_refund_id": "string", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0 }, "purchase_commission_on_price": 0, "purchase_commission_on_shipping": 0, "purchase_fee_amount": { "total_amount": 0 }, "purchase_price": 0, "purchase_shipping_price": 0 }, "quantity": 0, "reason_code": "string", "refund_id": "string", "shipping_amount": 0, "shipping_amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "shipping_taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ], "taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ] } ] } } }, "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": "OR28 - Perform refunds on order lines", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/cancel": { "put": { "description": "> ⚠️ **Content-length header**\n>\n> The Content-Length header must be present with value 0, even when there is no request body.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each order cancelation
    \n
    Maximum usage: At each order cancelation
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_CANCEL" ] } ], "summary": "OR29 - Perform a full cancelation of an order", "tags": [ "Orders" ] } }, "/api/orders/cancel": { "put": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each order (or order line) cancelation
    \n
    Maximum usage: At each order (or order line) cancelation
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "cancelations": [ { "amount": 2, "currency_iso_code": "USD", "fees": [ { "amount": 0.5, "code": "CARD_FEE" }, { "amount": 0.25, "code": "EU_DRS" } ], "order_line_id": "Order_00013-A-1", "quantity": 0, "reason_code": 34, "shipping_amount": 0, "shipping_taxes": [ { "amount": "1", "code": "tax1" }, { "amount": "1", "code": "tax2" } ], "taxes": [ { "amount": 1, "code": "tax1" }, { "amount": 1, "code": "tax2" } ] } ], "order_tax_mode": "TAX_EXCLUDED" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "cancelations": [ { "amount": 0, "currency_iso_code": "AED", "fees": [ { "amount": 0, "code": "string" } ], "order_line_id": "string", "quantity": 0, "reason_code": "string", "shipping_amount": 0, "shipping_taxes": [ { "amount": 0, "code": "string" } ], "taxes": [ { "amount": 0, "code": "string" } ] } ], "order_tax_mode": "TAX_INCLUDED" } } }, "schema": { "$ref": "#/components/schemas/OR30_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "cancelations": [ { "amount": 2, "cancelation_id": "1116", "currency_iso_code": "USD", "eco_contributions": [], "fees": [ { "amount": "1", "code": "fee1" }, { "amount": "1", "code": "fee2" } ], "order_line_id": "Order_00013-A-1", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0.2 }, "purchase_commission_on_price": 1, "purchase_commission_on_shipping": 1.5, "purchase_fee_amount": { "total_amount": 1.8 }, "purchase_price": 1, "purchase_shipping_price": 1.5 }, "quantity": 0, "reason_code": "34", "shipping_amount": 3, "shipping_taxes": [ { "amount": 1, "code": "tax1", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 }, "rate": 17.5 }, { "amount": 1, "code": "tax2", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 } } ], "taxes": [ { "amount": 1, "code": "tax1", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 }, "rate": 17.5 }, { "amount": 1, "code": "tax2", "purchase_tax": { "purchase_amount": 0.5, "purchase_rate": 7.5 } } ] } ], "order_tax_mode": "TAX_EXCLUDED" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "cancelations": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "cancelation_id": "string", "currency_iso_code": "AED", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "fees": [ { "amount": 0, "code": "string" } ], "order_line_id": "string", "purchase_information": { "purchase_commission_on_fees": { "total_amount": 0 }, "purchase_commission_on_price": 0, "purchase_commission_on_shipping": 0, "purchase_fee_amount": { "total_amount": 0 }, "purchase_price": 0, "purchase_shipping_price": 0 }, "quantity": 0, "reason_code": "string", "shipping_amount": 0, "shipping_amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "shipping_taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ], "taxes": [ { "amount": 0, "amount_breakdown": { "parts": [ { "amount": 0, "commissionable": true, "debitable_from_customer": true, "payable_to_shop": true } ] }, "code": "string", "purchase_tax": { "purchase_amount": 0, "purchase_rate": 0 }, "rate": 0 } ] } ], "order_tax_mode": "TAX_INCLUDED" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR30_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_CANCEL" ] } ], "summary": "OR30 - Perform cancelations on order lines", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/additional_fields": { "put": { "description": "
    Description
    \n\nOnly specified custom field values will be updated.
    In order to delete an custom field's value, set it to null or an empty string. Note that you may not delete the value of a required custom field value.
    Output will return information on the status of the update attempt by giving:
    • either all of the order and its order lines custom field values after the update
    • or in case of errors, the list of errors and the body of the initial call
    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time a custom field is updated on an order or on an order line
    \n
    Maximum usage: 5 calls per second
    \n
    ", "operationId": "OR31", "parameters": [ { "description": "Order 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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_additional_fields": [ { "code": "ecotax", "value": [ "15" ] } ], "order_lines": [ { "order_line_additional_fields": [ { "code": "delivery-countries", "value": [ "Canada" ] } ], "order_line_id": "Order_00014-A-1" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_lines": [ { "order_line_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_line_id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/OR31_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_update_result": { "order_additional_fields": [ { "code": "ecotax", "type": "MULTIPLE_VALUES_LIST", "value": [ "15" ] } ], "order_lines": [ { "order_line_additional_fields": [ { "code": "delivery-countries", "type": "MULTIPLE_VALUES_LIST", "value": [ "Canada" ] } ], "order_line_id": "Order_00014-A-1" } ] } } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_update_errors": { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "input": { "order_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_lines": [ { "order_line_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_line_id": "string" } ] } }, "order_update_result": { "order_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_lines": [ { "order_line_additional_fields": [ { "code": "string", "type": "STRING" } ], "order_line_id": "string" } ] } } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR31_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_ADDITIONAL_FIELD_UPDATE" ] } ], "summary": "OR31 - Update the custom fields of an order and its order lines", "tags": [ "Orders" ] } }, "/api/orders/adjust": { "put": { "description": "
    Description
    \n\n

    Update order line actual measurement either upwards or downwards, within the limit defined at the platform level.

    \n\n
    \nError Codes\n\n| Code | Description |\n|------|-------------|\n| ORDER_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
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each adjustment of one or multiple order lines
    \n
    Maximum usage: Once per minute, 100 order lines per call
    \n
    ", "operationId": "OR32", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_lines": [ { "actual_measurement": 0.85, "order_line_id": "ORDER_0014-A-1" }, { "actual_measurement": 1, "order_line_id": "ORDER_9999-A-1" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines": [ { "actual_measurement": 0, "order_line_id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/OR32_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_lines_adjusted": [ { "cancelations": [ { "amount": 10.17, "currency_iso_code": "CAD", "eco_contributions": [], "quantity": 0, "reason_code": "SYSTEM_CANCELATION_ADJUSTMENT", "shipping_amount": 0, "shipping_taxes": [ { "amount": 0, "code": "ORDER_OFFER_SHIPPING_TAX" } ], "taxes": [ { "amount": 1.5, "code": "ORDER_OFFER_TAX" } ] } ], "errors": [], "measurement": { "actual_measurement": 0.85, "adjustment_limit": 20, "measurement_unit": "KILOGRAM", "ordered_measurement": 1 }, "order_line_id": "ORDER_0014-A-1" }, { "errors": [ { "code": "ORDER_LINE_NOT_FOUND", "field": "order_line_id", "message": "Order line ORDER_9999-A-1 could not be found" } ], "order_line_id": "ORDER_9999-A-1" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines_adjusted": [ { "cancelations": [ { "amount": 0, "currency_iso_code": "AED", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "quantity": 0, "reason_code": "string", "shipping_amount": 0, "shipping_taxes": [ { "amount": 0, "code": "string" } ], "taxes": [ { "amount": 0, "code": "string" } ] } ], "errors": [ { "code": "string", "field": "string", "message": "string" } ], "measurement": { "actual_measurement": 0, "adjustment_limit": 0, "measurement_unit": "GRAM", "ordered_measurement": 0 }, "order_line_id": "string", "refunds": [ { "amount": 0, "currency_iso_code": "AED", "eco_contributions": [ { "epr_category_code": "string", "producer_id": "string", "producer_id_owner": "string", "total_amount": 0, "unit_amount": 0 } ], "quantity": 0, "reason_code": "string", "shipping_amount": 0, "shipping_taxes": [ { "amount": 0, "code": "string" } ], "taxes": [ { "amount": 0, "code": "string" } ] } ] } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR32_Response_200" } } }, "description": "OK" }, "400": { "description": "Too many order lines given" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_ADJUST" ] } ], "summary": "OR32 - Adjust order line", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/cancel-order-lines": { "put": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each order (or order line) cancelation
    \n
    Maximum usage: At each order (or order line) cancelation
    \n
    ", "operationId": "OR33", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_lines": [ { "id": "Order_00013-A-1", "reason_code": "34" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_lines": [ { "id": "string", "reason_code": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/OR33_Request" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_CANCEL" ] } ], "summary": "OR33 - Fully cancel a list of order lines of an order", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/messages": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be permanently removed **on April 5 2027**, please use M10 and M11 instead.\n\n
    Description
    \n\nBy default, all sent and received messages are listed\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each message page view
    \n
    Maximum usage: On each message page view
    \n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (desc by default)
    \n\n
    ", "operationId": "OR41", "parameters": [ { "description": "Order identifier", "explode": false, "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "If \"TRUE\" (\"FALSE\") returns only messages received by (sent to) shop.", "explode": true, "in": "query", "name": "received", "required": false, "schema": { "type": "string", "default": "ALL", "enum": [ "TRUE", "FALSE", "ALL" ] }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "messages": [ { "body": "I don't receive my product", "commercial_id": "MIR-8EFZBFMN", "date_created": "2019-04-16T09:15:43Z", "from_id": "546-77-7143", "from_name": "Smith Taylor", "from_type": "CUSTOMER", "id": 2026, "order_id": "MIR-8EFZBFMN-A", "subject": "Item not received", "to_shop_id": 115, "to_shop_name": "The Original House of Pies" } ], "total_count": 1 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "messages": [ { "archived": true, "body": "string", "commercial_id": "string", "date_created": "2023-03-28T09:34:42Z", "documents": [ { "date_uploaded": "2023-03-28T09:34:42Z", "file_name": "string", "file_size": 0, "id": 0, "type": "string" } ], "from_id": "string", "from_name": "string", "from_type": "OPERATOR", "id": 0, "offer_id": 0, "order_id": "string", "read": true, "subject": "string", "to_customer_archived": true, "to_customer_id": "string", "to_customer_name": "string", "to_operator": true, "to_operator_archived": true, "to_shop_archived": true, "to_shop_id": 0, "to_shop_name": "string", "visible": true } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR41_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "OR41 - List messages of an order", "tags": [ "Orders" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] }, "post": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API will be removed in a future version. Use OR43 and M12 instead.\n\n
    Description
    \n\nMaximum of 1000 messages on a thread\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each new message posted on an order
    \n
    Maximum usage: At each new message posted on an order
    \n
    Read More
    \n\n
    ", "operationId": "OR42", "parameters": [ { "description": "Order 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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "body": "I don't receive my product! Could you please tell me when should i received it?", "document_ids": [ "2032" ], "subject": "Item not received", "to_customer": false, "to_operator": false, "to_shop": true } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "body": "string", "document_ids": [ 0 ], "subject": "string", "to_customer": true, "to_operator": true, "to_shop": true } } }, "schema": { "$ref": "#/components/schemas/OR42_Request" } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "id": 2038 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "id": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR42_Response_201" } } }, "description": "Created" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "OR42 - Post a message on an order", "tags": [ "Messages" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/orders/{order_id}/threads": { "post": { "description": "
    Description
    \n\n

    Each message has a 30 Megabyte size limit, regardless of the number of attachments in the message.

    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each new thread posted on an order
    \n
    Maximum usage: At each new thread posted on an order
    \n
    ", "operationId": "OR43", "parameters": [ { "description": "Identifier of the order on which the thread is created", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "files": [ "string" ], "thread_input": { "body": "string", "to": [ "OPERATOR" ], "topic": { "type": "FREE_TEXT", "value": "string" } } } } }, "schema": { "type": "object", "properties": { "files": { "type": "array", "description": "List of attachments for the first message of the thread", "items": { "type": "string", "format": "binary" } }, "thread_input": { "$ref": "#/components/schemas/OR43_Request_MultipartFormData_ThreadInput", "description": "Thread content: body, topic, participants..." } }, "required": [ "thread_input" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "message_id": "00617ff1-7449-4574-a3a1-6fc256bf4d9b", "thread_id": "1f33b4f0-0cf8-4869-b148-e8e18b179770" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "message_id": "string", "thread_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR43_Response_201" } } }, "description": "Created" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_MESSAGE_WRITE" ] } ], "summary": "OR43 - Create a thread on an order", "tags": [ "Messages" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/orders/{order_id}/threads \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'files=@path/to/file' \\\n -F 'thread_input=\"{\\\"body\\\":\\\"string\\\",\\\"to\\\":[\\\"OPERATOR\\\"],\\\"topic\\\":{\\\"type\\\":\\\"FREE_TEXT\\\",\\\"value\\\":\\\"string\\\"}}\";type=application/json'\n" } ] } }, "/api/orders/{order_id}/evaluation": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: On each evaluation page view
    \n
    Maximum usage: On each evaluation page view
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "OR51", "parameters": [ { "explode": false, "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "assessments": [ { "code": "1", "label": "Shipping method as expected", "response": "1" }, { "code": "2", "label": "Product condition matched description", "response": "true" }, { "code": "3", "label": "Delivery deadline respected", "response": "true" }, { "code": "4", "label": "Product well packaged", "response": "2" } ], "comment": "Great seller, I recommend!", "customer_id": "Customer-001", "date": "2019-04-03T09:46:17Z", "firstname": "Taylor", "grade": 4, "last_updated_date": "2019-04-03T09:46:17Z", "lastname": "Smith", "reply": { "comment": "Owww thks", "date": "2019-06-25T16:00:00Z", "type": "SHOP" }, "visible": true } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "assessments": [ { "code": "string", "label": "string", "response": "string" } ], "comment": "string", "customer_id": "string", "date": "2023-03-28T09:34:42Z", "firstname": "string", "grade": 0, "last_updated_date": "2023-03-28T09:34:42Z", "lastname": "string", "reply": { "comment": "string", "date": "2023-03-28T09:34:42Z", "type": "OPERATOR" }, "visible": true } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR51_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_EVALUATION_READ" ] } ], "summary": "OR51 - Get the evaluation of an order", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/lines/{line}/resolve_incident": { "put": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each incident resolution on an order line
    \n
    Maximum usage: At each incident resolution on an order line
    \n
    Read More
    \n\n
    ", "operationId": "OR64", "parameters": [ { "description": "Order identifier", "explode": false, "in": "path", "name": "order_id", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "Order line identifier", "explode": false, "in": "path", "name": "line", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "reason_code": "8" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "reason_code": "string" } } }, "schema": { "$ref": "#/components/schemas/OR64_Request" } } } }, "responses": { "204": { "description": "No Content" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_INCIDENT_RESOLVE" ] } ], "summary": "OR64 - Mark an incident as resolved", "tags": [ "Incidents" ] } }, "/api/orders/documents": { "get": { "description": "
    Description
    \n\nReturns a list of all the documents available on the order\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each document list page display
    \n
    Maximum usage: At each document list page display
    \n
    ", "operationId": "OR72", "parameters": [ { "description": "the orders' identifiers, using comma as separator", "explode": true, "in": "query", "name": "order_ids", "required": true, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "order_documents": [ { "date_uploaded": "2019-03-29T13:17:02Z", "file_name": "delivery-Classic_Order_0006-A.pdf", "file_size": 64890, "id": 2024, "order_id": "Classic_Order_0006-A", "type": "SYSTEM_DELIVERY_BILL" }, { "date_uploaded": "2019-04-01T12:26:17Z", "file_name": "CA01.csv", "file_size": 47506, "id": 2025, "order_id": "Classic_Order_0006-A", "type": "CUSTOMER_INVOICE" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "order_documents": [ { "date_uploaded": "2023-03-28T09:34:42Z", "file_name": "string", "file_size": 0, "id": 0, "order_id": "string", "type": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR72_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_DOCUMENT_READ" ] } ], "summary": "OR72 - Lists order's documents", "tags": [ "Orders" ] } }, "/api/orders/documents/download": { "get": { "description": "
    Description
    \n\n
    • If a list of document identifiers is specified only these documents are downloaded.
      • If more than one document id is specified, the documents will be wrapped in a ZIP archive
      • If only one document id is specified the document will not be zipped
    • If a list of order identifiers is specified, all documents from those orders are downloaded.
      Use a list of order document type codes to retrieve specific types from those orders.
      In this case, the output of the API will always be a ZIP archive even if there is only one document to retrieve.
    When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow:
    \ndocuments-timestamp.zip\n|\n|__ 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
    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each document download
    \n
    Maximum usage: At each document download
    \n
    ", "operationId": "OR73", "parameters": [ { "description": "A list of identifiers of the orders (separated by a comma)", "explode": true, "in": "query", "name": "order_ids", "required": false, "schema": { "type": "string", "maximum": 100 }, "style": "form" }, { "description": "A list of document identifiers (separated by a comma)", "explode": true, "in": "query", "name": "document_ids", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_DOCUMENT_READ" ] } ], "summary": "OR73 - Download one or multiple documents attached to one or multiple orders", "tags": [ "Orders" ] } }, "/api/orders/{order_id}/documents": { "post": { "description": "
    Description
    \n\n

    \n Documents filenames must be distinct. Only documents of the following types are supported: csv, doc, xls, xlsx, ppt, pdf, odt, ods, odp, txt, rtf, png, jpg, gif, zpl, mov, mp4.
    \nAn order can have a maximum of 50 documents.\n In the API output we include only documents with errors. All other documents are successfully uploaded.\n

    \n

    For system document types, there are specific restrictions :

    \n
      \n
    • SYSTEM_DELIVERY_BILL/SYSTEM_SHIPMENT_DELIVERY_BILL : restricted to operator role.
      • \n
    • SYSTEM_MESSAGE_ATTACHMENT : cannot be directly uploaded to an order.
      • \n
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each document upload on an order
    \n
    Maximum usage: At each document upload on an order
    \n
    ", "operationId": "OR74", "parameters": [ { "description": "The identifier of the order", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "files": [ "string" ], "order_documents": { "order_documents": [ { "entity": { "id": "string", "type": "RETURN" }, "file_name": "string", "type_code": "string" } ] } } } }, "schema": { "type": "object", "properties": { "files": { "type": "array", "description": "The files to be uploaded. Use multipart/form-data with name 'files'. The file names must contain only US-ASCII characters. ", "items": { "type": "string", "format": "binary" } }, "order_documents": { "$ref": "#/components/schemas/OR74_Request_MultipartFormData_OrderDocuments", "description": "The list of documents to be uploaded details" } }, "required": [ "files", "order_documents" ] } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "errors_count": 1, "order_documents": [ { "errors": [ { "code": "valid_order_document.type", "field": "type_code", "message": "Unable to retrieve document's type from the given code" } ], "input": { "entity": { "id": "c0703388-df01-41c8-8a03-bc797c93515f", "type": "RETURN" }, "file_name": "return_label-38294.pdf", "type_code": "SYSTEM_RETURN_LABEL" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "errors_count": 0, "order_documents": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "input": { "file_name": "string", "type_code": "string" } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR74_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_DOCUMENT_WRITE" ] } ], "summary": "OR74 - Upload documents to attach to an order", "tags": [ "Orders" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/orders/{order_id}/documents \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'files=@path/to/file' \\\n -F 'order_documents=\"{\\\"order_documents\\\":[{\\\"entity\\\":{\\\"id\\\":\\\"string\\\",\\\"type\\\":\\\"RETURN\\\"},\\\"file_name\\\":\\\"string\\\",\\\"type_code\\\":\\\"string\\\"}]}\";type=application/json'\n" } ] } }, "/api/orders/taxes": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "taxes": [ { "code": "ECO_TAX", "label": "Eco tax", "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" }, { "code": "EXP_TAX", "label": "Export tax", "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" }, { "code": "CCT", "label": "New collectable commissionable tax", "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" }, { "code": "NCNCT", "label": "Collectable not commissionable tax", "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "taxes": [ { "code": "string", "label": "string", "tax_calculation_rule": "PROPORTIONAL_TO_AMOUNT" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/OR75_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ" ] } ], "summary": "OR75 - List all the order taxes available on the platform", "tags": [ "Orders" ] } }, "/api/orders/documents/{document_id}": { "delete": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each order document deletion
    \n
    Maximum usage: At each order document deletion
    \n
    ", "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", "required": false, "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": "OR76 - Delete an order document", "tags": [ "Orders" ] } }, "/api/products/offers": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 1 minute
    \n
    Maximum usage: 5 per minute
    \n
    Read More
    \n\n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • bestPrice (Default) - Sorts by product sku and then by total price, premium information, shop grade (asc by default)
    • bestEvaluation - Sorts by product sku and then by shop grade, total price, premium information (asc by default)
    \n\n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "List of the product's identifiers with type _(structure: \"`product_references=|,|, ...`\")_.
    \nLimited to 100 values. One of the two is required product_ids or product_references.\n\nExample: /api/products/offers?product_references=EAN|3120201243238\n", "explode": true, "in": "query", "name": "product_references", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "List of offer state codes", "explode": true, "in": "query", "name": "offer_state_codes", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "If false returns only active offers. If true return all offers.", "explode": true, "in": "query", "name": "all_offers", "required": false, "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", "required": false, "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.
    \nIf `true`, filters on all shop channels and ignores the channel_codes.\n", "explode": true, "in": "query", "name": "all_channels", "required": false, "schema": { "type": "boolean", "default": false }, "style": "form" }, { "description": "Filter used to pick prices on a specific channel", "explode": true, "in": "query", "name": "pricing_channel_code", "required": false, "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", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "List of shipping zones. Filter used to pick shipping prices on one or multiple shipping zones", "explode": true, "in": "query", "name": "shipping_zones", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "If `false`, filters the offers with the given shipping zones.
    \nIf `true`, selects all shop shipping zones and ignores the provided `shipping_zones`.\n", "explode": true, "in": "query", "name": "all_shipping_zones", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values for single channel pricing users (application/json)", "value": { "products": [ { "category_code": "5110114", "category_label": "Coffee Machines", "offers": [ { "active": true, "all_prices": [ { "channel_code": null, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-04-02T22:00:00Z", "price": 49, "unit_discount_price": 49, "unit_origin_price": 50, "volume_prices": [ { "price": 49, "quantity_threshold": 1, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 43, "quantity_threshold": 5, "unit_discount_price": 43, "unit_origin_price": 45 }, { "price": 39, "quantity_threshold": 10, "unit_discount_price": 39, "unit_origin_price": 40 } ] }, { "channel_code": "US", "context": { "channel_codes": [ "US" ] }, "discount_end_date": "2019-05-30T22:00:00Z", "discount_start_date": "2019-04-02T22:00:00Z", "price": 24, "unit_discount_price": 24, "unit_origin_price": 25, "volume_prices": [ { "price": 24, "quantity_threshold": 1, "unit_discount_price": 24, "unit_origin_price": 25 }, { "price": 22, "quantity_threshold": 10, "unit_discount_price": 22, "unit_origin_price": 23 }, { "price": 20, "quantity_threshold": 50, "unit_discount_price": 20, "unit_origin_price": 21 } ] }, { "channel_code": "US", "context": { "channel_codes": [ "US" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] } ], "allow_quote_requests": true, "applicable_pricing": { "channel_code": "US", "context": { "channel_codes": [ "US" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] }, "currency_iso_code": "USD", "description": "Offer for product MKP100000000037254", "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "inactivity_reasons": [ "SHOP_NOT_OPEN", "ZERO_QUANTITY" ], "is_professional": true, "leadtime_to_ship": 10, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "nb_evaluation": 3, "price": 24, "price_additional_info": "Apply Discount prices", "shipping_deadline": "2019-09-01T08:07:22.326Z", "shipping_types": [ { "code": "STD", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 1, "earliest_delivery_date": "2019-09-02T08:07:22.326Z", "latest_days": 2, "latest_delivery_date": "2019-09-03T08:07:22.326Z" }, "label": "Standard", "shipping_deadline": "2019-09-01T08:07:22.326Z", "shipping_price_type": "ORDER_PRICE_RANGE", "shipping_price_unit": 8, "shipping_zone_code": "DOM1", "shipping_zone_label": "Domestic 1", "standard_code": "CU_ADD-STD" }, { "code": "EXP", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 2, "earliest_delivery_date": "2019-09-04T08:07:22.326Z", "latest_days": 4, "latest_delivery_date": "2019-09-07T08:07:22.326Z" }, "label": "Express", "shipping_deadline": "2019-09-01T08:07:22.326Z", "shipping_price_type": "ORDER_PRICE_RANGE", "shipping_price_unit": 18, "shipping_zone_code": "DOM1", "shipping_zone_label": "Domestic 1", "standard_code": "CU_ADD-EXP" }, { "code": "STD", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 1, "earliest_delivery_date": "2019-09-02T08:07:22.326Z", "latest_days": 2, "latest_delivery_date": "2019-09-03T08:07:22.326Z" }, "label": "Standard", "shipping_deadline": "2019-09-01T08:07:22.326Z", "shipping_price_type": "FREE_SHIPPING", "shipping_price_unit": 0, "shipping_zone_code": "DOM2", "shipping_zone_label": "Domestic 2", "standard_code": "CU_ADD-STD" }, { "code": "EXP", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 2, "earliest_delivery_date": "2019-09-04T08:07:22.326Z", "latest_days": 4, "latest_delivery_date": "2019-09-07T08:07:22.326Z" }, "label": "Express", "shipping_deadline": "2019-09-01T08:07:22.326Z", "shipping_price_type": "FIXED_PRICE", "shipping_price_unit": 18, "shipping_zone_code": "DOM2", "shipping_zone_label": "Domestic 2", "standard_code": "CU_ADD-EXP" } ], "shop_grade": 4, "shop_name": "ACME SHOP", "state_code": "11", "total_price": 24 } ], "product_brand": "Breville", "product_description": "The Breville ESP8C Cafe Roma Stainless Espresso/Cappuccino Machine is a compact 1.2 litre espresso machine which features an advanced crema system and a 15-bar Italian made pump.", "product_media": { "media_url": "https://media-eu-1.mirakl.net/MEDIA/82f18041623746469c02bbd086abc0c3", "type": "LARGE" }, "product_references": [ { "reference": "9312432012041", "reference_type": "EAN" } ], "product_sku": "MKP100000000037254", "product_title": "Breville Cafe Roma Stainless Espresso/Cappuccino Machine - ESP8C", "total_count": 1 } ] } }, "application/json-1": { "summary": "Example with business values for multi channel pricing users (application/json)", "value": { "products": [ { "category_code": "5110114", "category_label": "Coffee Machines", "offers": [ { "active": true, "all_prices": [ { "channel_code": null, "discount_end_date": "2019-04-29T22:00:00Z", "discount_start_date": "2019-04-02T22:00:00Z", "price": 49, "unit_discount_price": 49, "unit_origin_price": 50, "volume_prices": [ { "price": 49, "quantity_threshold": 1, "unit_discount_price": 49, "unit_origin_price": 50 }, { "price": 43, "quantity_threshold": 5, "unit_discount_price": 43, "unit_origin_price": 45 }, { "price": 39, "quantity_threshold": 10, "unit_discount_price": 39, "unit_origin_price": 40 } ] }, { "channel_code": null, "context": { "channel_codes": [ "US" ] }, "discount_end_date": "2019-05-30T22:00:00Z", "discount_start_date": "2019-04-02T22:00:00Z", "price": 24, "unit_discount_price": 24, "unit_origin_price": 25, "volume_prices": [ { "price": 24, "quantity_threshold": 1, "unit_discount_price": 24, "unit_origin_price": 25 }, { "price": 22, "quantity_threshold": 10, "unit_discount_price": 22, "unit_origin_price": 23 }, { "price": 20, "quantity_threshold": 50, "unit_discount_price": 20, "unit_origin_price": 21 } ] }, { "channel_code": null, "context": { "channel_codes": [ "US", "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] } ], "allow_quote_requests": true, "applicable_pricing": { "channel_code": null, "context": { "channel_codes": [ "US", "FR" ], "customer_group_ids": [ "Group2", "Group3" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-12-31T23:59:59Z", "start_date": "2023-01-01T00:00:00Z" }, "discount_end_date": "2023-01-31T22:00:00Z", "discount_start_date": "2023-03-31T22:00:00Z", "price": 29, "unit_discount_price": 29, "unit_origin_price": 30, "volume_prices": [ { "price": 29, "quantity_threshold": 1, "unit_discount_price": 29, "unit_origin_price": 30 }, { "price": 19, "quantity_threshold": 20, "unit_discount_price": 19, "unit_origin_price": 20 }, { "price": 14, "quantity_threshold": 100, "unit_discount_price": 14, "unit_origin_price": 15 } ] }, "currency_iso_code": "USD", "description": "Offer for product MKP100000000037254", "eco_contributions": [ { "eco_contribution_amount": 3.59, "epr_category_code": "FR-DEA", "producer_id": "FR123456_89ABCD" }, { "eco_contribution_amount": 0.99, "epr_category_code": "DE-WEEE", "producer_id": "ProducerID1" } ], "inactivity_reasons": [ "SHOP_NOT_OPEN", "ZERO_QUANTITY" ], "is_professional": true, "leadtime_to_ship": 10, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "CLC", "min_shipping_zone": "DOM1", "nb_evaluation": 3, "price": 24, "price_additional_info": "Apply Discount prices", "shipping_deadline": "2019-09-01T23:59:59.999Z", "shipping_types": [ { "code": "STD", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 1, "earliest_delivery_date": "2019-09-02T08:07:22.326Z", "latest_days": 2, "latest_delivery_date": "2019-09-03T08:07:22.326Z" }, "label": "Standard", "shipping_deadline": "2019-09-01T23:59:59.999Z", "shipping_price_type": "ORDER_PRICE_RANGE", "shipping_price_unit": 8, "shipping_zone_code": "DOM1", "shipping_zone_label": "Domestic 1", "standard_code": "CU_ADD-STD" }, { "code": "EXP", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 2, "earliest_delivery_date": "2019-09-04T08:07:22.326Z", "latest_days": 4, "latest_delivery_date": "2019-09-07T08:07:22.326Z" }, "label": "Express", "shipping_deadline": "2019-09-01T23:59:59.999Z", "shipping_price_type": "ORDER_PRICE_RANGE", "shipping_price_unit": 18, "shipping_zone_code": "DOM1", "shipping_zone_label": "Domestic 1", "standard_code": "CU_ADD-EXP" }, { "code": "STD", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 1, "earliest_delivery_date": "2019-09-02T08:07:22.326Z", "latest_days": 2, "latest_delivery_date": "2019-09-03T08:07:22.326Z" }, "label": "Standard", "shipping_deadline": "2019-09-01T23:59:59.999Z", "shipping_price_type": "FREE_SHIPPING", "shipping_price_unit": 0, "shipping_zone_code": "DOM2", "shipping_zone_label": "Domestic 2", "standard_code": "CU_ADD-STD" }, { "code": "EXP", "cut_off_next_date": "2024-02-17T15:00:00.000Z", "cut_off_time": "17:00+02:00", "delivery_time": { "earliest_days": 2, "earliest_delivery_date": "2019-09-04T08:07:22.326Z", "latest_days": 4, "latest_delivery_date": "2019-09-07T08:07:22.326Z" }, "label": "Express", "shipping_deadline": "2019-09-01T23:59:59.999Z", "shipping_price_type": "FIXED_PRICE", "shipping_price_unit": 18, "shipping_zone_code": "DOM2", "shipping_zone_label": "Domestic 2", "standard_code": "CU_ADD-EXP" } ], "shop_grade": 4, "shop_name": "ACME SHOP", "state_code": "11", "total_price": 24 } ], "product_brand": "Breville", "product_description": "The Breville ESP8C Cafe Roma Stainless Espresso/Cappuccino Machine is a compact 1.2 litre espresso machine which features an advanced crema system and a 15-bar Italian made pump.", "product_media": { "media_url": "https://media-eu-1.mirakl.net/MEDIA/82f18041623746469c02bbd086abc0c3", "type": "LARGE" }, "product_references": [ { "reference": "9312432012041", "reference_type": "EAN" } ], "product_sku": "MKP100000000037254", "product_title": "Breville Cafe Roma Stainless Espresso/Cappuccino Machine - ESP8C", "total_count": 1 } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "products": [ { "category_code": "string", "category_label": "string", "measurement": { "total_measurement_of_product": 0, "unit": "string" }, "offers": [ { "active": true, "all_prices": [ { "channel_code": "string", "context": { "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "start_date": "2023-03-28T09:34:42Z" }, "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "price": 0, "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] } ], "allow_quote_requests": true, "applicable_pricing": { "channel_code": "string", "context": { "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "start_date": "2023-03-28T09:34:42Z" }, "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ { "price": 0, "quantity_threshold": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ] }, "available_end_date": "2023-03-28T09:34:42Z", "available_start_date": "2023-03-28T09:34:42Z", "channels": [ "string" ], "currency_iso_code": "AED", "description": "string", "discount": { "discount_price": 0, "end_date": "2023-03-28T09:34:42Z", "origin_price": 0, "ranges": [ { "price": 0, "quantity_threshold": 0 } ], "start_date": "2023-03-28T09:34:42Z" }, "eco_contributions": [ { "eco_contribution_amount": 0, "epr_category_code": "FR-AGROPACK", "producer_id": "string" } ], "favorite_rank": 0, "inactivity_reasons": [ "PRODUCT_STATUS_NEW" ], "is_professional": true, "leadtime_to_ship": 0, "logistic_class": { "code": "string", "label": "string" }, "min_quantity_alert": 0, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "string", "min_shipping_zone": "string", "msrp": 0, "nb_evaluation": 0, "offer_additional_fields": [ { "code": "string", "type": "STRING" } ], "offer_id": 0, "premium": true, "price": 0, "price_additional_info": "string", "quantity": 0, "retail_prices": [ { "discount_end_date": "2023-03-28T09:34:42Z", "discount_start_date": "2023-03-28T09:34:42Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0 } ], "shipping_deadline": "2023-03-28T09:34:42Z", "shipping_types": [ { "code": "string", "cut_off_next_date": "2023-03-28T09:34:42Z", "cut_off_time": "string", "delivery_time": { "earliest_days": 0, "earliest_delivery_date": "2023-03-28T09:34:42Z", "latest_days": 0, "latest_delivery_date": "2023-03-28T09:34:42Z" }, "label": "string", "shipping_deadline": "2023-03-28T09:34:42Z", "shipping_price_type": "FIXED_PRICE", "shipping_price_unit": 0, "shipping_zone_code": "string", "shipping_zone_label": "string", "standard_code": "string" } ], "shop_grade": 0, "shop_id": 0, "shop_name": "string", "state_code": "string", "total_price": 0 } ], "product_brand": "string", "product_description": "string", "product_media": { "dam_url": "string", "media_url": "string", "type": "string" }, "product_references": [ { "reference": "string", "reference_type": "string" } ], "product_sku": "string", "product_title": "string", "total_count": 0 } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/P11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_READ" ] } ], "summary": "P11 - List offers for each given product", "tags": [ "Offers" ] } }, "/api/products": { "get": { "description": "
    Description
    \n\nNote: this resource returns 100 products maximum
    Results are sorted by product sku asc, then by product identifier type asc and then by product identifier asc\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each product page display
    \n
    Maximum usage: At each product page display
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "P31", "parameters": [ { "description": "List of the product's identifiers with type, _(structure: \"`product_references=|,|, ...`\")_\nwhere accepted `` are operator’s product references, like `EAN` or `UPC` for example.\n\nNote that `SHOP_SKU` or `SKU` are invalid `` for this API.\n", "explode": true, "in": "query", "name": "product_references", "required": true, "schema": { "type": "string" }, "style": "form" }, { "deprecated": true, "description": "List of the product's identifiers with type, _(structure: \"`products=|,|, ...`\")_\nwhere accepted `` are operator’s product references, like `EAN` or `UPC` for example.\n\nNote that `SHOP_SKU` or `SKU` are invalid `` for this API.\n", "explode": true, "in": "query", "name": "products", "required": false, "schema": { "type": "string", "deprecated": true }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "products": [ { "category_code": "5110114", "category_label": "Coffee Machines", "product_id": "9312432012041", "product_id_type": "EAN", "product_sku": "MKP100000000037254", "product_title": "Breville Cafe Roma Stainless Espresso/Cappuccino Machine - ESP8C" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "products": [ { "category_code": "string", "category_label": "string", "product_id": "string", "product_id_type": "string", "product_sku": "string", "product_title": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/P31_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_READ" ] } ], "summary": "P31 - Get products for a list of product references", "tags": [ "Products" ] } }, "/api/products/imports": { "post": { "description": "
    Description
    \n\nReturns the import identifier to track the status of the import\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every hour, for each seller
    \n
    Maximum usage: Every 15 minutes, for each seller
    \n
    ", "operationId": "P41", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "conversion_options": { "ai_enrichment": { "status": "ENABLED" }, "ai_rewrite": { "status": "ENABLED" }, "ai_translation": { "status": "ENABLED" } }, "conversion_type": "AI_CONVERTER", "file": "string", "operator_format": true } } }, "schema": { "type": "object", "properties": { "conversion_options": { "$ref": "#/components/schemas/P41_Request_MultipartFormData_ConversionOptions", "description": "Options used for product file conversion when conversion_type is AI_CONVERTER" }, "conversion_type": { "type": "string", "description": "Product file conversion type. If Catalog Transformer is enabled but the conversionType is not specified, then the default configuration from the shop settings will be used\n\nEnum: `\"AI_CONVERTER\"`, `\"STANDARD\"`\n" }, "file": { "type": "string", "format": "binary", "description": "Import file (CSV or XML or XLSX) to upload. Use multipart/form-data with name file" }, "operator_format": { "type": "boolean", "default": false, "description": "Force the use of the operator product format" } }, "required": [ "file" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "import_id": 2035 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "import_id": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/P41_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_PRODUCT_WRITE" ] } ], "summary": "P41 - Import products to the operator information system", "tags": [ "Products" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/products/imports \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'conversion_options=\"{\\\"ai_enrichment\\\":{\\\"status\\\":\\\"ENABLED\\\"},\\\"ai_rewrite\\\":{\\\"status\\\":\\\"ENABLED\\\"},\\\"ai_translation\\\":{\\\"status\\\":\\\"ENABLED\\\"}}\";type=application/json' \\\n -F 'conversion_type=\"\\\"AI_CONVERTER\\\"\";type=application/json' \\\n -F 'file=@path/to/file' \\\n -F 'operator_format=\"true\";type=application/json'\n" } ] }, "get": { "description": "
    Description
    \n\nIf the last_request_date param is not set the api returns all product imports.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (asc by default)
    \n\n
    ", "operationId": "P51", "parameters": [ { "description": "Return only product imports that have changed since this date", "explode": true, "in": "query", "name": "last_request_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Product import status. One of CANCELLED, WAITING, RUNNING, SENT, COMPLETE, FAILED", "explode": true, "in": "query", "name": "status", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "If true returns only product import trackings with transformed file", "explode": true, "in": "query", "name": "has_transformed_file", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "product_import_trackings": [ { "date_created": "2019-04-05T13:13:06Z", "has_error_report": true, "has_new_product_report": true, "has_transformation_error_report": true, "has_transformed_file": false, "import_id": 2008, "import_status": "COMPLETE", "shop_id": 2000, "transform_lines_in_error": 5, "transform_lines_in_success": 0, "transform_lines_read": 5, "transform_lines_with_warning": 0 }, { "date_created": "2019-04-05T13:13:25Z", "has_error_report": false, "has_new_product_report": false, "has_transformation_error_report": false, "has_transformed_file": true, "import_id": 2009, "import_status": "SENT", "shop_id": 2000, "transform_lines_in_error": 0, "transform_lines_in_success": 1, "transform_lines_read": 1, "transform_lines_with_warning": 0 } ], "total_count": 2 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "product_import_trackings": [ { "conversion_options": { "ai_enrichment": { "status": "ENABLED" }, "ai_rewrite": { "status": "ENABLED" }, "ai_translation": { "status": "ENABLED" } }, "conversion_type": "AI_CONVERTER", "date_created": "2023-03-28T09:34:42Z", "has_error_report": true, "has_new_product_report": true, "has_transformation_error_report": true, "has_transformed_file": true, "import_id": 0, "import_status": "TRANSFORMATION_WAITING", "integration_details": { "invalid_products": 0, "products_not_accepted_in_time": 0, "products_not_synchronized_in_time": 0, "products_reimported": 0, "products_successfully_synchronized": 0, "products_with_synchronization_issues": 0, "products_with_wrong_identifiers": 0, "rejected_products": 0 }, "reason_status": "string", "shop_id": 0, "transform_lines_in_error": 0, "transform_lines_in_success": 0, "transform_lines_read": 0, "transform_lines_with_warning": 0 } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/P51_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ] } ], "summary": "P51 - Get information about product import statuses", "tags": [ "Products" ] } }, "/api/products/imports/{import}": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per minute until getting the import final status
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "P42", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "date_created": "2019-04-05T12:56:21Z", "has_error_report": false, "has_new_product_report": false, "has_transformation_error_report": false, "has_transformed_file": true, "import_id": 2005, "import_status": "SENT", "shop_id": 2000, "transform_lines_in_error": 0, "transform_lines_in_success": 1, "transform_lines_read": 1, "transform_lines_with_warning": 0 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "conversion_options": { "ai_enrichment": { "status": "ENABLED" }, "ai_rewrite": { "status": "ENABLED" }, "ai_translation": { "status": "ENABLED" } }, "conversion_type": "AI_CONVERTER", "date_created": "2023-03-28T09:34:42Z", "has_error_report": true, "has_new_product_report": true, "has_transformation_error_report": true, "has_transformed_file": true, "import_id": 0, "import_status": "TRANSFORMATION_WAITING", "integration_details": { "invalid_products": 0, "products_not_accepted_in_time": 0, "products_not_synchronized_in_time": 0, "products_reimported": 0, "products_successfully_synchronized": 0, "products_with_synchronization_issues": 0, "products_with_wrong_identifiers": 0, "rejected_products": 0 }, "reason_status": "string", "shop_id": 0, "transform_lines_in_error": 0, "transform_lines_in_success": 0, "transform_lines_read": 0, "transform_lines_with_warning": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/P42_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ] } ], "summary": "P42 - Get the import status for a product import", "tags": [ "Products" ] } }, "/api/products/imports/{import}/error_report": { "get": { "description": "
    Description
    \n\nThis API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time an error report is needed
    \n
    Maximum usage: Each time an error report is needed
    \n
    ", "operationId": "P44", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ] } ], "summary": "P44 - Get the error report file for a product import (\"Non-integrated products report\")", "tags": [ "Products" ] } }, "/api/products/imports/{import}/new_product_report": { "get": { "description": "
    Description
    \n\nThis API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time an integration report is needed
    \n
    Maximum usage: Each time an integration report is needed
    \n
    Read More
    \n\n
    ", "operationId": "P45", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ] } ], "summary": "P45 - Get the product integration report file for a product import (\"Added products report\")", "tags": [ "Products" ] } }, "/api/products/imports/{import}/transformed_file": { "get": { "description": "
    Description
    \n\nThis API returns a CSV file.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time a transformed file is available
    \n
    Maximum usage: Each time a transformed file is available
    \n
    Read More
    \n\n
    ", "operationId": "P46", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "text/csv": { "examples": { "text/csv-auto": { "summary": "Complete example with value types (text/csv)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ] } ], "summary": "P46 - Get the transformed file for a product import (\"File in operator format\")", "tags": [ "Products" ] } }, "/api/products/imports/{import}/transformation_error_report": { "get": { "description": "
    Description
    \n\nThis API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time an error report is needed
    \n
    Maximum usage: Each time an error report is needed
    \n
    Read More
    \n\n
    ", "operationId": "P47", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import", "required": true, "schema": { "type": "integer", "format": "int64" }, "style": "simple" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_WRITE" ] } ], "summary": "P47 - Get the transformation error report file for a product import (\"Source file error report\")", "tags": [ "Products" ] } }, "/api/platform/configuration": { "get": { "description": "
    Description
    \n\nList platform configurations such as general information, modules and features activated.
    \n
    \nNote: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office.\n\n\n
    \n
    ", "operationId": "PC01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "features": { "catalog": { "allow_shop_contribution_to_all_channels": true, "exclude_invalid_products": true, "list_of_multiple_values_separator": "|", "product_acceptance_by_channel": true, "product_data_validation_by_channel": true, "product_import_only_on_leaf": true }, "circular_economy_data_collection": false, "competitive_pricing_tool": false, "direct_payment_customer_store": { "activated": false, "refund_cancel_authorized": false }, "disable_seller_alternative_carrier": false, "lead_time_to_ship_by_sellers_enabled": "YES", "multi_currency": true, "no_reply_needed": true, "offer_prices_decimals": "2", "operator_csv_delimiter": "SEMICOLON", "order_conditions": { "lead_time_to_ship": true, "maximum_order_quantity": false, "minimum_order_quantity": false, "package_order_quantity": false }, "order_tax_mode": "TAX_EXCLUDED", "order_workflows": { "no_customer_payment_confirmation": true, "order_acceptance": "NOT_AUTOMATIC", "pause_debit_workflow": false, "pay_on_due_date": true, "pay_on_shipment": true, "sellers_edit_shipping_origin": false, "shipping_and_billing_details_before_acceptance": false }, "pricing": { "channel_pricing": "DISABLED", "scheduled_pricing": false, "volume_discount": true, "volume_pricing": false }, "product_data_validation_by_channel": true, "shipment": { "multi_part_item_shipment": true, "multi_shipment": true }, "shop_tax_options": { "local_tax_number": { "mandatory": true, "validation_regex": "regex_local_tax_number" }, "tax_identification_number": { "mandatory": true, "validation_regex": "regex_tax_identification_number" } }, "tax_collection": { "activated": "NO", "product_tax_code_mandatory": true, "tax_collection_by_operator": false }, "tax_id_number": { "mandatory": false }, "warehouses": { "geolocation": true, "restricted_countries": [ "FRA", "USA" ] } }, "modules": { "mirakl_catalog_integrator": true, "mirakl_catalog_manager": false, "mirakl_catalog_transformer": true, "mirakl_platform_services": false, "offer_management": true, "order_management": true, "promotions": true, "quotes": true, "tax_manager": { "activated": false, "tax_provider": { "avalara": false, "vertex": false } } }, "platform_configuration": { "customer_model": { "b2b": false, "b2c": true }, "platform_model": { "drop_ship": true, "marketplace": true, "one_creditor": true } }, "platform_name": "", "tenant_name": "tenantname-prod", "timezone": "Europe/Paris" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "features": { "catalog": { "allow_shop_contribution_to_all_channels": true, "exclude_invalid_products": true, "list_of_multiple_values_separator": "string", "product_acceptance_by_channel": true, "product_data_validation_by_channel": true, "product_import_only_on_leaf": true }, "circular_economy_data_collection": true, "competitive_pricing_tool": true, "direct_payment_customer_store": { "activated": true, "refund_cancel_authorized": true }, "disable_seller_alternative_carrier": true, "dropship": { "retail_pricing_edition_enabled": "YES", "retail_pricing_enabled": true }, "kyc_status_per_seller": true, "lead_time_to_ship_by_sellers_enabled": "YES", "multi_currency": true, "multi_payout_psp_per_seller": true, "no_reply_needed": true, "offer_prices_decimals": "string", "operator_csv_delimiter": "COMMA", "order_conditions": { "lead_time_to_ship": true, "maximum_order_quantity": true, "minimum_order_quantity": true, "package_order_quantity": true }, "order_tax_mode": "TAX_INCLUDED", "order_workflows": { "no_customer_payment_confirmation": true, "order_acceptance": "AUTOMATIC", "pause_debit_workflow": true, "pay_on_due_date": true, "pay_on_shipment": true, "sellers_edit_shipping_origin": true, "shipping_and_billing_details_before_acceptance": true }, "payment_confirmation": true, "pricing": { "channel_pricing": "MULTI", "discount_period_required": true, "discount_price_creation_in_the_past_blocked": true, "scheduled_pricing": true, "volume_discount": true, "volume_pricing": true }, "product_data_validation_by_channel": true, "promotion": { "cart_promotion_campaign": true, "discount_campaign": true, "seller_promotion": true }, "returns": { "drop_ship": true, "marketplace": true, "one_creditor": true }, "shipment": { "multi_part_item_shipment": true, "multi_shipment": true }, "shop_tax_options": { "local_tax_number": { "mandatory": true, "validation_regex": "string" }, "tax_identification_number": { "mandatory": true, "validation_regex": "string" } }, "tax_collection": { "activated": "YES", "product_tax_code_mandatory": true, "tax_collection_by_operator": true }, "tax_id_number": { "mandatory": true, "validation_regex": "string" }, "warehouses": { "geolocation": true, "restricted_countries": [ "AFG" ] } }, "modules": { "mirakl_catalog_integrator": true, "mirakl_catalog_manager": true, "mirakl_catalog_transformer": true, "mirakl_platform_services": true, "offer_management": true, "offer_management_mode": "string", "order_management": true, "order_management_mode": "string", "promotions": true, "quotes": true, "tax_manager": { "activated": true, "tax_provider": { "avalara": true, "vertex": true } } }, "platform_configuration": { "customer_model": { "b2b": true, "b2c": true }, "enhanced_seller_invoicing": { "enabled": true }, "platform_model": { "drop_ship": true, "marketplace": true, "one_creditor": true } }, "platform_name": "string", "tenant_name": "string", "timezone": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/PC01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "PC01 - List platform configurations", "tags": [ "Platform Settings" ] } }, "/api/picklists": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 15 minutes
    \n
    Maximum usage: Every 5 minutes
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • pickupDate (Default) - Sort by pickup date (asc by default)
    \n\n
    ", "operationId": "PL11", "parameters": [ { "description": "Pick run code for filtering.", "explode": true, "in": "query", "name": "pickrun_code", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter picklists with a pick-up date after the given date.", "explode": true, "in": "query", "name": "pickup_date_min", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter picklists with a pick-up date before the given date.", "explode": true, "in": "query", "name": "pickup_date_max", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Picklist id for filtering. This parameter can be supplied multiple times (picklist_id=OR01-A&picklist_id=OR02-A...).", "explode": true, "in": "query", "name": "picklist_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Picklist state for filtering. This parameter can be supplied multiple times (picklist_state=WAITING_PREPARATION&picklist_state=IN_PREPARATION...).", "explode": true, "in": "query", "name": "picklist_state", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...).", "explode": true, "in": "query", "name": "order_line_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "date_created": "2022-09-28T13:37:00Z", "id": "picklist01", "last_updated": "2022-09-28T13:37:00Z", "order_lines": [ { "id": "ORDER-001-A-1" }, { "id": "ORDER-001-A-2" }, { "id": "ORDER-002-A-1" }, { "id": "ORDER-003-A-1" } ], "picklist_lines": [ { "offer_id": 2135, "quantity": 3 }, { "offer_id": 2136, "quantity": 1 } ], "pickrun_code": "pickrun1", "pickup_date": "2022-10-01T00:00:00Z", "shop_id": 2000, "state": "WAITING_PREPARATION" }, { "date_created": "2022-09-28T15:00:00Z", "id": "picklist02", "last_updated": "2022-09-28T15:00:00Z", "order_lines": [ { "id": "ORDER-004-A-1" } ], "picklist_lines": [ { "offer_id": 2201, "quantity": 15 } ], "pickrun_code": null, "pickup_date": "2022-10-24T00:00:00Z", "shop_id": 2000, "state": "WAITING_PREPARATION" } ], "next_page_token": "bGltaXQ9MSZhZnRlcj0yMDIyLTEyLTI0VDAwOjAwOjAwWiZhZnRlcj04Y2ViNWQxZi05MjQ4LTQyYjEtYTdkNS05NzYwNzAxOGQzNGEmc29ydD1waWNrdXBEYXRlLEFTQw==", "previous_page_token": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "date_created": "2023-03-28T09:34:42Z", "id": "string", "last_updated": "2023-03-28T09:34:42Z", "order_lines": [ { "id": "string" } ], "picklist_lines": [ { "offer_id": 0, "quantity": 0 } ], "pickrun_code": "string", "pickup_date": "2023-03-28T09:34:42Z", "shop_id": 0, "state": "NOTHING_TO_PREPARE" } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/PL11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PICKLIST_READ" ] } ], "summary": "PL11 - List picklists", "tags": [ "Picklists" ] } }, "/api/products/attributes": { "get": { "description": "
    Description
    \n\nRetrieves all attributes for parents and children of the requested hierarchy\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every hour
    \n
    Maximum usage: Every hour
    \n
    Read More
    \n\n
    ", "operationId": "PM11", "parameters": [ { "description": "Code of the hierarchy (category) for which to retrieve the attributes. If not specified, all attributes are retrieved.", "explode": true, "in": "query", "name": "hierarchy", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Number of children hierarchy (category) levels to retrieve. If not specified, attributes from all children hierarchies are retrieved.", "explode": true, "in": "query", "name": "max_level", "required": false, "schema": { "type": "integer", "format": "int32" }, "style": "form" }, { "description": "Set to \"true\" to get all the operator attributes.", "explode": true, "in": "query", "name": "all_operator_attributes", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "attributes": [ { "channels": [ { "code": "WEBSITE_EN" } ], "code": "washingInstructions3", "default_value": null, "description": "How do you wash the product", "description_translations": [ { "locale": "en", "value": "How do you wash the product" } ], "example": null, "hierarchy_code": "3012", "label": "Washing Instructions", "label_translations": [ { "locale": "en", "value": "Washing Instructions" } ], "locale": "en_US", "requirement_level": "OPTIONAL", "roles": [], "transformations": "CAMEL_CASE", "type": "TEXT", "type_parameter": null, "validations": "MIN_LENGTH|10", "variant": false }, { "channels": [ { "code": "WEBSITE_FR" }, { "code": "WEBSITE_EN" } ], "code": "toolsIncluded3", "default_value": null, "description": "Are tools included for the assembly of this product", "description_translations": [ { "locale": "en", "value": "Are tools included for the assembly of this product" } ], "example": null, "hierarchy_code": "5610102", "label": "Tools Included", "label_translations": [ { "locale": "en", "value": "Tools Included" } ], "requirement_level": "OPTIONAL", "roles": [], "type": "LIST", "type_parameter": "Boolean", "variant": false } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "attributes": [ { "channels": [ { "code": "string" } ], "code": "string", "default_value": "string", "description": "string", "description_translations": [ { "locale": "string", "value": "string" } ], "example": "string", "hierarchy_code": "string", "label": "string", "label_translations": [ { "locale": "string", "value": "string" } ], "locale": "string", "required": true, "requirement_level": "OPTIONAL", "roles": [ { "parameters": [ { "name": "string", "value": "string" } ], "type": "string" } ], "transformations": "string", "type": "string", "type_parameter": "string", "type_parameters": [ { "name": "string", "value": "string" } ], "unique_code": "string", "validations": "string", "values": [ { "code": "string" } ], "values_list": "string", "variant": true } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/PM11_Response_200" } }, "text/csv": { "examples": { "text/csv-1": { "summary": "Example with business values (text/csv)", "value": "code;label;label[en];hierarchy-code;description;description[en];example;requirement-level;type;type-parameter;variant;default-value;transformations;validations;roles;type-parameters;channels;locale\nwashingInstructions3;Washing Instructions;Washing Instructions;3012;How do you wash the product;How do you wash the product;;OPTIONAL;TEXT;;false;;CAMEL_CASE;MIN_LENGTH|10;;;WEBSITE_EN;en_US\ntoolsIncluded3;Tools Included;Tools Included;5610102;Are tools included for the assembly of this product;Are tools included for the assembly of this product;;OPTIONAL;LIST;Boolean;false;;;;;LIST_CODE|Boolean;WEBSITE_FR,WEBSITE_EN;\n" }, "text/csv-auto": { "summary": "Complete example with value types (text/csv)", "value": "string" } }, "schema": { "type": "object", "format": "binary", "$ref": "#/components/schemas/PM11_Response_200_TextCsv_Ext_FileStructure" } } }, "description": "Export success" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_CONFIGURATION_READ" ] } ], "summary": "PM11 - Get the product attribute configuration", "tags": [ "Products" ] } }, "/api/promotions": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each display of a promotions list page or on-promo offer detail page.
    \n
    Maximum usage: At each display of a promotions list page or on-promo offer detail page.
    \n
    Pagination
    \n\n

    This resource supports offset pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • startDate (Default) - Sort by promotion activity start date (Newest first) (desc by default)
    • endDate - Sort by promotion activity end date (Newest first) (desc by default)
    • dateCreated - Sort by promotion creation date (Newest first) (desc by default)
    \n\n
    ", "operationId": "PR01", "parameters": [ { "description": "A comma separated list of identifiers for a promotion", "explode": true, "in": "query", "name": "ids", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter promotion creation date lower limit", "explode": true, "in": "query", "name": "date_created_from", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter promotion creation date upper limit", "explode": true, "in": "query", "name": "date_created_to", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Promotion-triggering offer ids, separated by commas", "explode": true, "in": "query", "name": "trigger_offer_ids", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Promotion reward offer ids, separated by commas", "explode": true, "in": "query", "name": "reward_offer_ids", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Channel codes on which promotions apply, separated by commas", "explode": true, "in": "query", "name": "channel_codes", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "promotions": [ { "application_to_cart": [ { "promo_code": "SUMMER20" } ], "campaign": { "identifier": "SUMMERSALE" }, "date_created": "2023-04-03T16:18:59.924Z", "end_date": "2023-08-30T22:00:00.000Z", "internal_description": "Summer sale event", "internal_id": "SUMMERSALE_3", "last_updated": "2023-07-20T14:21:57.532Z", "medias": [ { "locale": "en_US", "url": "https://xxxx-xxxx.mirakl.net/mmp/media/promotion-media/ac63d67a-62c5-4c9a-8483-b704494abc45" }, { "locale": "fr_FR", "url": "https://xxxx-xxxx.mirakl.net/mmp/media/promotion-media/ac63d67a-62c5-4c9a-8483-b704494abc45" } ], "percentage_off": 10, "public_descriptions": [ { "locale": "en_US", "value": "Summer promotions" }, { "locale": "fr_FR", "value": "Promotions d'été" } ], "reward_offer_ids": [ 2131 ], "reward_on_purchased_items": false, "start_date": "2023-04-03T16:18:59.922Z", "state": "ACTIVE", "trigger_offer_ids": [ 2130 ], "triggers": [ { "quantity_purchased": 1, "same_item_purchased": false, "type": "every_quantity" } ], "type": "PERCENTAGE_OFF" } ], "total_count": 1 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "promotions": [ { "amount_off": 0, "application_to_cart": [ { "promo_code": "string" } ], "campaign": { "identifier": "string" }, "channels": [ { "code": "string", "label": "string" } ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "date_created": "2023-03-28T09:34:42Z", "end_date": "2023-03-28T09:34:42Z", "free_items_quantity": 0, "internal_description": "string", "internal_id": "string", "last_updated": "2023-03-28T09:34:42Z", "max_quantity_to_discount": 0, "medias": [ { "locale": "string", "url": "string" } ], "percentage_off": 0, "public_descriptions": [ { "locale": "string", "value": "string" } ], "reduced_unit_price": 0, "reward_offer_ids": [ 0 ], "reward_on_purchased_items": true, "start_date": "2023-03-28T09:34:42Z", "state": "ACTIVE", "trigger_offer_ids": [ 0 ], "triggers": [ { "amount_purchased": 0, "quantity_purchased": 0, "same_item_purchased": true, "type": "minimum_quantity" } ], "type": "AMOUNT_OFF" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/PR01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PROMOTION_READ" ] } ], "summary": "PR01 - List promotions", "tags": [ "Promotions" ] }, "post": { "description": "
    \n
    Call Frequency
    \n\n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with all values (application/json)", "value": { "application_to_cart": [ { "promo_code": "SUMMER20" } ], "channel_codes": [ "US" ], "customer_group_ids": [ "Group2" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-08-30T22:00:00.000Z", "internal_description": "Summer sale event", "internal_id": "SUMMERSALE_3", "public_descriptions": [ { "locale": "en_US", "value": "Summer promotions" }, { "locale": "fr_FR", "value": "Promotions d'été" } ], "reward": { "max_quantity_to_discount": 1, "percentage_off": 10, "selection": { "type": "BRAND", "values": [ "Samsung", "Belkin" ] }, "type": "PERCENTAGE_OFF" }, "start_date": "2023-04-03T16:18:59.922Z", "trigger": { "quantity_purchased": 1, "same_item_purchased": false, "selection": { "type": "ALL" }, "type": "EVERY_QUANTITY" } } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "application_to_cart": [ { "promo_code": "string" } ], "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "internal_description": "string", "internal_id": "string", "public_descriptions": [ { "locale": "string", "value": "string" } ], "reward": { "selection": { "type": "PURCHASED_ITEMS" }, "type": "FREE_ITEMS" }, "start_date": "2023-03-28T09:34:42Z", "trigger": { "selection": { "type": "ALL" }, "type": "MINIMUM_QUANTITY" } } } }, "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": "PR03 - Create a promotion", "tags": [ "Promotions" ] } }, "/api/promotions/{promotion_internal_id}": { "put": { "description": "
    \n
    Call Frequency
    \n\n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with all values (application/json)", "value": { "application_to_cart": [ { "promo_code": "SUMMER20" } ], "channel_codes": [ "US" ], "customer_group_ids": [ "Group2" ], "customer_organization_ids": [ "Org1" ], "end_date": "2023-08-30T22:00:00.000Z", "internal_description": "Summer sale event", "public_descriptions": [ { "locale": "en_US", "value": "Summer promotions" }, { "locale": "fr_FR", "value": "Promotions d'été" } ], "reward": { "selection": { "type": "BRAND", "values": [ "Samsung", "Belkin" ] } }, "start_date": "2023-04-03T16:18:59.922Z", "trigger": { "selection": { "type": "ALL" } } } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "application_to_cart": [ { "promo_code": "string" } ], "channel_codes": [ "string" ], "customer_group_ids": [ "string" ], "customer_organization_ids": [ "string" ], "end_date": "2023-03-28T09:34:42Z", "internal_description": "string", "public_descriptions": [ { "locale": "string", "value": "string" } ], "reward": { "selection": { "type": "PURCHASED_ITEMS" } }, "start_date": "2023-03-28T09:34:42Z", "trigger": { "selection": { "type": "ALL" } } } } }, "schema": { "$ref": "#/components/schemas/PR04_Request" } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "PR04 - Update a promotion", "tags": [ "Promotions" ] } }, "/api/offers/pricing/imports": { "post": { "description": "
    Description
    \n\nImport a .csv file to submit all applicable prices for an offer.
    \nThe import mode is delete and replace: any existing price that is not submitted will be deleted.
    \nIf Price Approval is enabled, this API creates and updates pending prices; ongoing prices will remain.
    \nReturns an import identifier to track the status of the import and retrieve an error report if applicable.
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "PRI01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-0": { "summary": "Non Advanced Pricing users", "value": { "file": "offer-sku;price;price-ranges;discount-price;discount-ranges;discount-start-date;discount-end-date\nSKU001;20;1|20,10|15;18;1|18,10|12;2024-01-01T23:00:00Z;2024-06-30T23:00:00Z\n" } }, "multipart/form-data-1": { "summary": "Channel Pricing", "value": { "file": "offer-sku;price;price-ranges;discount-price;discount-ranges;channels;discount-start-date;discount-end-date\nSKU001;20;1|20,10|15;18;1|18,10|12;;2024-01-01T23:00:00Z;2024-06-30T23:00:00Z\nSKU001;30;1|30,10|20;25;1|25,10|15;US|CA;2024-01-01T23:00:00Z;\nSKU001;22;;16;;FR;;\n" } }, "multipart/form-data-2": { "summary": "Scheduled Pricing", "value": { "file": "offer-sku;price;price-ranges;discount-price;discount-ranges;start-date;end-date;discount-start-date;discount-end-date\nSKU001;20;1|20,10|15;;;;;;\nSKU001;20;1|20,10|15;18;1|18,10|12;2024-01-01T23:00:00Z;2024-03-30T23:00:00Z;;\nSKU001;15;;10;;2024-04-01T23:00:00Z;2024-06-30T23:00:00Z;2024-05-01T23:00:00Z;2024-05-30T23:00:00Z\n" } }, "multipart/form-data-3": { "summary": "Customer Pricing", "value": { "file": "offer-sku;price;price-ranges;discount-price;discount-ranges;customer-organization-ids;customer-group-ids;discount-start-date;discount-end-date\nSKU001;20;1|20,10|15;;;;;;\nSKU001;20;1|20,10|15;18;1|18,10|12;ORG-001|ORG-002|ORG-003;;2024-05-01T23:00:00Z;2024-05-30T23:00:00Z\nSKU001;15;;10;;;GROUP-001|GROUP-001|GROUP-003;2024-05-01T23:00:00Z;2024-05-30T23:00:00Z\nSKU001;16;;;;ORG-004;GROUP-004|GROUP-005;;\n" } }, "multipart/form-data-4": { "summary": "Dropship Retail Pricing", "value": { "file": "offer-sku;price-type;price;discount-price;discount-start-date;discount-end-date\nSKU001;PRICE;20;;;\nSKU001;RETAIL-PRICE;25;;;\nSKU002;PRICE;30;28;2024-12-31T00:00:00Z;2025-12-31T00:00:00Z\nSKU002;RETAIL-PRICE;35;32;2024-12-31T00:00:00Z;2025-12-31T00:00:00Z\n" } }, "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "file": "string" } } }, "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Import CSV file to upload. Use multipart/form-data with name file.
    \nCsv format:
    \n
      \n
    • \"offer-sku\";\"price\";\"discount-price\";\"discount-start-date\";\"discount-end-date\"
      • \n
        \n
      • 1 line = 1 offer price
        • \n
      • List prices for the same offer together
        • \n
      • Limits: 50 prices can be created for an offer
        • \n
      \n
    • Volume Pricing users: use additional columns price-ranges and discount-ranges
      • \n
    • Channel Pricing users: use additional column channels
      • \n
    • Scheduled Pricing users: use additional columns start-date and end-date
      • \n
    • Customer Pricing users: use additional columns customer-organization-ids and customer-group-ids
      • \n
    • Retail pricing users (only for Dropship offers, with appropriate settings): use additional column price-type to define if you are providing a price or a retail price value\n
    \n" } }, "required": [ "file" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "import_id": "7d98c3c0-81fe-407d-9721-d4b01951c8d8" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "importId": "string", "import_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/PRI01_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_PRICING_WRITE" ] } ], "summary": "PRI01 - Import a price file", "tags": [ "Offers" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/offers/pricing/imports \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'file=@path/to/file'\n" } ] }, "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: After each PRI01 call, every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (desc by default)
    \n\n
    ", "operationId": "PRI02", "parameters": [ { "description": "Import identifiers", "explode": true, "in": "query", "name": "import_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Start creation date for filtering", "explode": true, "in": "query", "name": "start_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "End creation date for filtering", "explode": true, "in": "query", "name": "end_date", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Offer import status", "explode": true, "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "WAITING", "RUNNING", "COMPLETE", "FAILED" ] }, "style": "form" }, { "description": "List of offer pricing import origins for filtering.", "explode": true, "in": "query", "name": "origins", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "API", "FTP", "SFTP", "HTTP", "HTTPS", "FRONT", "PENDING_OFFERS" ] } }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "date_created": "2023-03-28T09:34:42Z", "has_error_report": true, "import_id": "string", "lines_in_error": 0, "lines_in_success": 0, "offers_in_error": 0, "offers_updated": 0, "origin": "API", "reason_status": "string", "shop_id": 0, "status": "WAITING" } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/PRI02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_PRICING_READ" ] } ], "summary": "PRI02 - Get information and statistics about an offer pricing import", "tags": [ "Offers" ] } }, "/api/offers/pricing/imports/{import_id}/error_report": { "get": { "description": "
    Description
    \n\nOnly returns lines of offers with at least one offer price in error.
    \nThe first column contains the line number in error. The second column contains the error reason.
    \nThe returned file is ready to be reimported after the values have been fixed.
    \nOffer prices that were submitted in the price import but don't appear in the error report were successfully imported.\n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: After each PRI02 call, every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "PRI03", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "text/csv": { "examples": { "text/csv-auto": { "summary": "Complete example with value types (text/csv)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_PRICING_READ" ] } ], "summary": "PRI03 - Get the error report for a price import in CSV format", "tags": [ "Offers" ] } }, "/api/reasons": { "get": { "description": "
    Description
    \n\nThis API returns cancellation, refund, incident, and message reasons.
    Reasons are sorted by type then sort index (set in the back-office)\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time a page must display a list of reasons
    \n
    Maximum usage: Each time a page must display a list of reasons
    \n
    Read More
    \n\n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "RE01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "reasons": [ { "code": "1", "is_shop_right": false, "label": "Item not received", "type": "INCIDENT_OPEN" }, { "code": "10", "is_shop_right": false, "label": "Replacement item received", "type": "INCIDENT_CLOSE" }, { "code": "15", "is_shop_right": true, "label": "Out of stock", "type": "REFUND" }, { "code": "26", "is_shop_right": true, "label": "Other question", "type": "ORDER_MESSAGING" }, { "code": "33", "is_shop_right": true, "label": "Other question", "type": "OFFER_MESSAGING" }, { "code": "34", "is_shop_right": true, "label": "Cancelled by the client prior to shipping", "type": "CANCELATION" }, { "code": "MMP_SELLER_MESSAGING_ONBOARDING", "is_shop_right": true, "label": "Onboarding", "type": "MMP_SELLER_MESSAGING" }, { "code": "MPS_SELLER_MESSAGING_ONBOARDING", "is_shop_right": true, "label": "Onboarding", "type": "MPS_SELLER_MESSAGING" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "reasons": [ { "code": "string", "is_shop_right": true, "label": "string", "type": "INCIDENT_OPEN" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RE01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ" ] } ], "summary": "RE01 - List reasons", "tags": [ "Platform Settings" ] } }, "/api/reasons/{reason_type}": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in future update. Consider using RE01.\n\n
    Description
    \n\nThis API returns cancellation, refund, incident, and message reasons.
    Reasons are sorted by sort index (set in the back-office)\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Each time a page must display a list of reasons
    \n
    Maximum usage: Each time a page must display a list of reasons
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "operationId": "RE02", "parameters": [ { "description": "Reason type", "explode": false, "in": "path", "name": "reason_type", "required": true, "schema": { "type": "string", "enum": [ "INCIDENT_CLOSE", "REFUND", "MPS_REFUND", "MESSAGING", "ORDER_MESSAGING", "MPS_ORDER_MESSAGING", "MPS_OFFER_MESSAGING", "OFFER_MESSAGING", "CANCELATION" ] }, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "reasons": [ { "code": "14", "label": "No response from the shop" }, { "code": "15", "label": "Out of stock" }, { "code": "16", "label": "Cancelled by the client prior to shipping" }, { "code": "17", "label": "Item returned" }, { "code": "18", "label": "Item not received" }, { "code": "19", "label": "Agreement found with the vendor" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "reasons": [ { "code": "string", "label": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RE02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SETTINGS_READ" ] } ], "summary": "RE02 - List reasons by type", "tags": [ "Platform Settings" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/reasons/incident_open": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in future update, use RE02 with parameter reason_type='INCIDENT_OPEN'\n\n
    Description
    \n\nNote: Result returns only reasons where the user's role have the right
    Note: Reasons are sorted by sort index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once on incident creation page view
    \n
    Maximum usage: Once on incident creation page view
    \n
    ", "operationId": "RE11", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "reasons": [ { "code": "1", "label": "Item not received" }, { "code": "2", "label": "Item not as ordered" }, { "code": "3", "label": "Defective item" }, { "code": "4", "label": "Right to retract order" }, { "code": "5", "label": "Counterfeit item" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "reasons": [ { "code": "string", "label": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RE11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "RE11 - List of reasons with type: incident open", "tags": [ "Platform Settings" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/reasons/incident_close": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in future update, use RE02 with parameter reason_type='INCIDENT_CLOSE'\n\n
    Description
    \n\nNote: Result returns only reasons where the user's role have the right
    Note: Reasons are sorted by sort index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once on incident closing page view
    \n
    Maximum usage: Once on incident closing page view
    \n
    ", "operationId": "RE12", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "reasons": [ { "code": "8", "label": "I finally received my order" }, { "code": "9", "label": "Item fit the description after all" }, { "code": "10", "label": "Replacement item received" }, { "code": "11", "label": "Agreement made with the vendor" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "reasons": [ { "code": "string", "label": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RE12_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "RE12 - List of reasons with type: incident close", "tags": [ "Platform Settings" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/reasons/messaging": { "get": { "deprecated": true, "description": "
    Deprecated endpoint
    \n\nThis API is going to be removed in future update, use RE02 with parameter reason_type='MESSAGING'\n\n
    Description
    \n\nNote: Result returns only reasons where the user's role have the right
    Note: Reasons are sorted by sort index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once on message creation page view
    \n
    Maximum usage: Once on message creation page view
    \n
    ", "operationId": "RE14", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "reasons": [ { "code": "20", "label": "Question about delivery" }, { "code": "21", "label": "Cancel the order" }, { "code": "22", "label": "Issue with item received" }, { "code": "23", "label": "Item not received" }, { "code": "24", "label": "Request an invoice" }, { "code": "25", "label": "Information on the product" }, { "code": "26", "label": "Other question" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "reasons": [ { "code": "string", "label": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RE14_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "RE14 - List of reasons with type: messaging", "tags": [ "Platform Settings" ], "x-badges": [ { "color": "noIntegrationBadge", "name": "⚠️ No Integration Allowed ⚠️", "position": "after" } ] } }, "/api/users/shops/roles": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: On each user role view
    \n
    Maximum usage: On each user role view
    \n
    Read More
    \n\n
    ", "operationId": "RO02", "parameters": [ { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "roles": [ { "code": "GROUP_SHOP_ADMIN", "description": "Access to \"Dashboard Statistics\", access to the \"Settings\", \"Information\", and \"User Management\" menus, ability to call Shop API." }, { "code": "GROUP_SHOP_ACCOUNTANCY", "description": "Access to \"Statements\" and \"Transaction History\"." }, { "code": "GROUP_SHOP_INVENTORY", "description": "Access to \"Inventory\" dashboard, management and messages, and \"Mapping Configuration\"." }, { "code": "GROUP_SHOP_SALES", "description": "Access to \"Message\", \"Order\" and \"Revenue\" dashboards, and \"Order Management\"." }, { "code": "GROUP_SHOP_SUPPORT", "description": "Access to \"Message\" and \"Order\" dashboards, ability to upload order documents and edit seller order references." } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "roles": [ { "code": "string", "description": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RO02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_SHOP_USER_CREATE", "ROLE_SHOP_ADMIN" ] } ], "summary": "RO02 - List shop roles", "tags": [ "Users" ] } }, "/api/returns": { "post": { "description": "
    Description
    \n\nLimited to 200 returns at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each customer return request
    \n
    Maximum usage: At each customer return request
    \n
    Read More
    \n\n
    ", "operationId": "RT01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "accepted": null, "label_url": "https://www.label-url.com", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "ORDER-001", "reason_code": "RETURN_CHANGED_MIND", "return_lines": [ { "order_line_id": "ORDER-001-A-1", "quantity": 1 }, { "order_line_id": "ORDER-001-B-2", "quantity": 2 } ], "rma": "RETURN_RMA" }, { "accepted": true, "description": "Description of return", "label_url": null, "method_code": "RETURN_METHOD_DROP_OFF_POINT", "order_commercial_id": "ORDER-DROPSHIP-1", "reason_code": "RETURN_CHANGED_MIND", "return_lines": [ { "order_line_id": "ORDER-DROPSHIP-1-A-1", "quantity": 1 } ], "rma": null } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "accepted": true, "description": "string", "label_url": "string", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "string", "reason_code": "RETURN_BROKEN_ITEM", "return_lines": [ { "order_line_id": "string", "quantity": 0, "reason_code": "string" } ], "rma": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/RT01_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "message": "The returns are not enabled for the platform model of the order line ORDER-DROPSHIP-1-A-1", "order_commercial_id": "ORDER-DROPSHIP-1" } ], "return_success": [ { "date_created": "2022-09-28T13:37:00Z", "description": "Description of return", "documents": [], "id": "ef0e41b6-35ed-4103-86a1-0e33d50a6b05", "label_url": "https://www.label-url.com", "last_updated": "2022-09-28T13:37:00Z", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "ORDER-001", "order_id": "ORDER-001-A", "reason_code": "RETURN_CHANGED_MIND", "rejection_reason_code": null, "return_address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "return_lines": [ { "compliance": null, "order_line_id": "ORDER-001-A-1", "quantity": 1 } ], "rma": "RETURN_RMA", "status": "WAITING_ACCEPTANCE", "tracking": null }, { "date_created": "2022-09-28T13:37:00Z", "documents": [], "id": "ef0e41b6-35ed-4103-86a1-0e33d50a6b05", "label_url": null, "last_updated": "2022-09-28T13:37:00Z", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "ORDER-001", "order_id": "ORDER-001-B", "reason_code": "RETURN_CHANGED_MIND", "rejection_reason_code": null, "return_address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "return_lines": [ { "compliance": null, "order_line_id": "ORDER-001-B-2", "quantity": 2 } ], "rma": null, "status": "WAITING_ACCEPTANCE", "tracking": null } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "message": "string", "order_commercial_id": "string" } ], "return_success": [ { "date_created": "2023-03-28T09:34:42Z", "description": "string", "documents": [ { "id": 0, "type": "string" } ], "id": "string", "label_url": "string", "last_updated": "2023-03-28T09:34:42Z", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "string", "order_id": "string", "reason_code": "RETURN_BROKEN_ITEM", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE", "return_address": { "city": "string", "country_iso_code": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" }, "return_lines": [ { "compliance": [ { "compliant": true, "non_compliance_additional_info": "string", "non_compliance_reason_code": "string" } ], "order_line_id": "string", "quantity": 0, "reason_code": "RETURN_BROKEN_ITEM" } ], "rma": "string", "state": "WAITING_ACCEPTANCE", "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT01_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_ORDER_RETURN_WRITE", "ROLE_SHOP_ADMIN" ] } ], "summary": "RT01 - Create returns", "tags": [ "Returns" ] }, "put": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each update of one or multiple returns
    \n
    Maximum usage: At each update of one or multiple returns
    \n
    ", "operationId": "RT04", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "id": "f61b5db8-d8f5-4715-b05f-aa4432c0e9e2", "tracking": { "tracking_url": "https://www.tracking.com" } }, { "id": "c91b5db8-d8f5-4715-b05f-aa4432c0e989", "tracking": { "tracking_url": "https://invalid_url" } }, { "id": "2dc4f7d7", "tracking": { "tracking_url": "https://www.tracking.com" } }, { "id": "21456f96-19ef-4f34-97be-6cf937755f01", "rma": "RETURN_RMA" }, { "id": "2dc4f7d7-da59-4588-bec7-ce62daab2f93", "label_url": "https://www.label-url.com", "rma": "RETURN_RMA", "tracking": { "carrier_name": "customCarrier", "tracking_number": "1H79D0K76", "tracking_url": "https://www.tracking.com" } }, { "id": "1716be7a-93f0-4242-b55b-fff05a76d168", "label_url": "https://www.label-url.com", "rma": "RETURN_RMA", "tracking": { "carrier_code": "UPS", "tracking_number": "6HD869420" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "id": "string", "label_url": "string", "method_code": "RETURN_METHOD_BY_MAIL", "return_address": { "address": { "city": "string", "country_iso_code": "AFG", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" } }, "rma": "string", "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ] } } }, "schema": { "$ref": "#/components/schemas/RT04_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "id": "f61b5db8-d8f5-4715-b05f-aa4432c0e9e2", "message": "Return is in invalid state" }, { "id": "c91b5db8-d8f5-4715-b05f-aa4432c0e989", "message": "Invalid return tracking URL format" }, { "id": "21456f96-19ef-4f34-97be-6cf937755f01", "message": "Order is in invalid state" }, { "id": "2dc4f7d7", "message": "The return id is incorrect." } ], "return_success": [ { "date_created": "2023-02-27T16:32:52Z", "description": "Description of return", "documents": [], "id": "2dc4f7d7-da59-4588-bec7-ce62daab2f93", "label_url": "https://www.label-url.com", "last_updated": "2023-02-27T16:37:19Z", "method_code": "RETURN_METHOD_DROP_OFF", "order_commercial_id": "ORDER-2", "order_id": "ORDER-2-A", "reason_code": "RETURN_COUNTERFEIT_ITEM", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE", "return_address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "return_lines": [ { "compliance": [ { "compliant": false, "non_compliance_additional_info": "There is a missing item", "non_compliance_reason_code": "RETURN_NON_COMPLIANT_MISSING_ITEM" } ], "order_line_id": "ORDER-2-A-1", "quantity": 1 } ], "rma": "RETURN_RMA", "state": "REFUSED", "tracking": { "carrier_code": null, "carrier_name": "newCarrier", "carrier_standard_code": null, "tracking_number": "1H79D0K76", "tracking_url": "https://www.tracking.com" } }, { "date_created": "2023-04-18T15:24:51Z", "documents": [], "id": "1716be7a-93f0-4242-b55b-fff05a76d168", "label_url": "https://www.label-url.com", "last_updated": "2023-05-27T16:37:19Z", "method_code": "RETURN_METHOD_DROP_OFF", "order_commercial_id": "ORDER-2", "order_id": "ORDER-2-A", "reason_code": "RETURN_COUNTERFEIT_ITEM", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE", "return_address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "return_lines": [ { "compliance": [ { "compliant": false, "non_compliance_additional_info": "There is a missing item", "non_compliance_reason_code": "RETURN_NON_COMPLIANT_MISSING_ITEM" } ], "order_line_id": "ORDER-2-A-1", "quantity": 1 } ], "rma": "RETURN_RMA", "state": "REFUSED", "tracking": { "carrier_code": "UPS", "carrier_name": "UPS", "carrier_standard_code": "ups", "tracking_number": "6HD869420", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=6HD869420" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "id": "string", "message": "string" } ], "return_success": [ { "date_created": "2023-03-28T09:34:42Z", "description": "string", "documents": [ { "id": 0, "type": "string" } ], "id": "string", "label_url": "string", "last_updated": "2023-03-28T09:34:42Z", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "string", "order_id": "string", "reason_code": "RETURN_BROKEN_ITEM", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE", "return_address": { "city": "string", "country_iso_code": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" }, "return_lines": [ { "compliance": [ { "compliant": true, "non_compliance_additional_info": "string", "non_compliance_reason_code": "string" } ], "order_line_id": "string", "quantity": 0, "reason_code": "RETURN_BROKEN_ITEM" } ], "rma": "string", "state": "WAITING_ACCEPTANCE", "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT04_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_WRITE" ] } ], "summary": "RT04 - Patch update returns", "tags": [ "Returns" ] }, "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 15 minutes
    \n
    Maximum usage: Every 5 minutes
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • date_created (Default) - Sort by return date creation (asc by default)
    \n\n
    ", "operationId": "RT11", "parameters": [ { "description": "Return id for filtering. This parameter can be supplied multiple times (return_id=58fd00d1-4ea4-453e-9a56-ec28c5c156ea&return_id=3071c162-dcd9-414b-a39d-ac3165f29453...).", "explode": true, "in": "query", "name": "return_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Return state for filtering. This parameter can be supplied multiple times (return_state=WAITING_ACCEPTANCE&return_state=IN_PROGRESS...).", "explode": true, "in": "query", "name": "return_state", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Filter returns with a creation date after the given date.", "explode": true, "in": "query", "name": "return_creation_date_from", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter returns with a creation date before the given date.", "explode": true, "in": "query", "name": "return_creation_date_to", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter returns updated after the given date.", "explode": true, "in": "query", "name": "return_last_updated_from", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter returns updated before the given date.", "explode": true, "in": "query", "name": "return_last_updated_to", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Order commercial id for filtering. This parameter can be supplied multiple times (order_commercial_id=OR01-A&order_commercial_id=OR02-A...).", "explode": true, "in": "query", "name": "order_commercial_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...).", "explode": true, "in": "query", "name": "order_line_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Return RMA for filtering. This parameter can be supplied multiple times (return_rma=RMA-1&return_rma=RMA-2...).", "explode": true, "in": "query", "name": "return_rma", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Customer id for filtering. This parameter can be supplied multiple times (customer_id=id1&customer_id=id2...).", "explode": true, "in": "query", "name": "customer_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "date_created": "2023-02-27T16:14:52Z", "description": "Description of return", "documents": [ { "id": 1337, "type": "SYSTEM_RETURN_LABEL" } ], "id": "f61b5db8-d8f5-4715-b05f-aa4432c0e9e2", "label_url": null, "last_updated": "2023-02-27T16:14:52Z", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "ORDER-1", "order_id": "ORDER-1-A", "reason_code": "RETURN_CHANGED_MIND", "rejection_reason_code": null, "return_address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "return_lines": [ { "compliance": [ { "compliant": false, "non_compliance_additional_info": "There is a missing item", "non_compliance_reason_code": "RETURN_NON_COMPLIANT_MISSING_ITEM" } ], "order_line_id": "ORDER-1-A-1", "quantity": 2 }, { "compliance": null, "order_line_id": "ORDER-1-A-2", "quantity": 3 } ], "rma": "RETURN_RMA", "state": "WAITING_ACCEPTANCE", "tracking": { "carrierCode": "UPS", "carrierName": "UPS", "carrier_standard_code": "ups", "tracking_number": "35H8O95K", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=35H8O95K" } }, { "date_created": "2023-02-27T16:32:52Z", "documents": [], "id": "2dc4f7d7-da59-4588-bec7-ce62daab2f93", "label_url": "https://www.label-url.com", "last_updated": "2023-02-27T16:37:19Z", "method_code": "RETURN_METHOD_DROP_OFF", "order_commercial_id": "ORDER-2", "order_id": "ORDER-2-A", "reason_code": "RETURN_COUNTERFEIT_ITEM", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE", "return_address": { "city": "New York", "country_iso_code": "USA", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "zip_code": "NY 10012" }, "return_lines": [ { "compliance": [ { "compliant": true, "non_compliance_additional_info": null, "non_compliance_reason_code": null } ], "order_line_id": "ORDER-2-A-1", "quantity": 1 } ], "rma": null, "state": "REFUSED", "tracking": null } ], "next_page_token": "dGhpcy1pcy1hLWZha2UtcGFnZS10b2tlbi1wbGVhc2UtcmVseS1vbi10aGUtdG9rZW4tcHJvdmlkZWQtYnktdGhlLWFwaS1yZXNwb25zZQo=", "previous_page_token": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "date_created": "2023-03-28T09:34:42Z", "description": "string", "documents": [ { "id": 0, "type": "string" } ], "id": "string", "label_url": "string", "last_updated": "2023-03-28T09:34:42Z", "method_code": "RETURN_METHOD_BY_MAIL", "order_commercial_id": "string", "order_id": "string", "reason_code": "RETURN_BROKEN_ITEM", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE", "return_address": { "city": "string", "country_iso_code": "string", "state": "string", "street1": "string", "street2": "string", "zip_code": "string" }, "return_lines": [ { "compliance": [ { "compliant": true, "non_compliance_additional_info": "string", "non_compliance_reason_code": "string" } ], "order_line_id": "string", "quantity": 0, "reason_code": "RETURN_BROKEN_ITEM" } ], "rma": "string", "state": "WAITING_ACCEPTANCE", "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_ORDER_RETURN_READ", "ROLE_SHOP_ADMIN" ] } ], "summary": "RT11 - List returns", "tags": [ "Returns" ] } }, "/api/returns/items_to_return": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each customer return request
    \n
    Maximum usage: At each customer return request
    \n
    Read More
    \n\n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • order_line_id (Default) - Sort by order line id (asc by default)
    \n\n
    ", "operationId": "RT12", "parameters": [ { "description": "Order commercial id for filtering. This parameter can be supplied multiple times (order_commercial_id=OR01-A&order_commercial_id=OR02-A...).", "explode": true, "in": "query", "name": "order_commercial_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...).", "explode": true, "in": "query", "name": "order_line_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode": true, "in": "query", "name": "shop_id", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "available_return_methods": null, "available_return_reasons": null, "order_commercial_id": "test", "order_line_id": "test-A-1", "return_window": null, "return_window_end_date": null, "return_window_start_date": null, "returnable_quantity": 0 }, { "available_return_methods": [ "RETURN_METHOD_BY_MAIL", "RETURN_METHOD_DROP_OFF" ], "available_return_reasons": [ "RETURN_CHANGED_MIND", "RETURN_COUNTERFEIT_ITEM" ], "order_commercial_id": "test", "order_line_id": "test-B-1", "return_window": 14, "return_window_end_date": "2026-01-29T00:00:00Z", "return_window_start_date": "2026-01-15T00:00:00Z", "returnable_quantity": 1 } ], "next_page_token": "dGhpcy1pcy1hLWZha2UtcGFnZS10b2tlbi1wbGVhc2UtcmVseS1vbi10aGUtdG9rZW4tcHJvdmlkZWQtYnktdGhlLWFwaS1yZXNwb25zZQo=", "previous_page_token": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "available_return_methods": [ "string" ], "available_return_reasons": [ "string" ], "order_commercial_id": "string", "order_line_id": "string", "return_window": 0, "return_window_end_date": "2023-03-28T09:34:42Z", "return_window_start_date": "2023-03-28T09:34:42Z", "returnable_quantity": 0 } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT12_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_ORDER_RETURN_READ", "ROLE_SHOP_ADMIN" ] } ], "summary": "RT12 - List items to return", "tags": [ "Returns" ] } }, "/api/returns/accept": { "put": { "description": "
    Description
    \n\nLimited to 100 returns at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each acceptance or refusal decision for one or multiple returns
    \n
    Maximum usage: At each acceptance or refusal decision for one or multiple returns
    \n
    Read More
    \n\n
    ", "operationId": "RT21", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "accepted": true, "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6" }, { "accepted": false, "id": "b77907cb-f72e-4f69-aac3-14df566311de", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE" }, { "accepted": true, "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "accepted": true, "id": "string", "rejection_reason_code": "RETURN_REJECTION_NOT_ELIGIBLE" } ] } } }, "schema": { "$ref": "#/components/schemas/RT21_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6", "message": "Return is in invalid state" }, { "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a", "message": "The return does not exist." } ], "return_success": [ { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "id": "string", "message": "string" } ], "return_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT21_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_WRITE" ] } ], "summary": "RT21 - Accept or refuse a return request", "tags": [ "Returns" ] } }, "/api/returns/receive": { "put": { "description": "
    Description
    \n\nLimited to 100 returns at a time\n\n
    \nError Codes\n\n| Code | Description |\n|------|-------------|\n| RETURN_DUPLICATE_ID | The returns list contains duplicate return IDs |\n| RETURN_HANDLED_BY_OPERATOR | This return is handled by the operator and cannot be managed by the shop |\n| RETURN_INVALID_STATE | The return is not in the expected state for this operation |\n| RETURN_NOT_ENABLED | Returns are not enabled |\n| RETURN_NOT_FOUND | The requested return does not exist |\n| VALIDATION_ERROR | Input validation failed |\n\n
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each receipt of one or multiple returns
    \n
    Maximum usage: At each receipt of one or multiple returns
    \n
    ", "operationId": "RT25", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6" }, { "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a" }, { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/RT25_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "code": "RETURN_INVALID_STATE", "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6", "message": "Return is in state WAITING_ACCEPTANCE, expected IN_PROGRESS" }, { "code": "RETURN_NOT_FOUND", "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a", "message": "The return does not exist." } ], "return_success": [ { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "code": "string", "id": "string", "message": "string" } ], "return_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT25_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_PARTNER_ORDER_RETURN_WRITE", "ROLE_SHOP_ADMIN" ] } ], "summary": "RT25 - Validate returns as received", "tags": [ "Returns" ] } }, "/api/returns/compliance": { "put": { "description": "
    Description
    \n\nLimited to 100 returns at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each compliance decision for one or multiple returns
    \n
    Maximum usage: At each compliance decision for one or multiple returns
    \n
    ", "operationId": "RT26", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "id": "f61b5db8-d8f5-4715-b05f-aa4432c0e9e2", "return_lines": [ { "compliant": true, "order_line_id": "OR01-A-1" }, { "compliant": false, "non_compliance_additional_info": "There is a missing item", "non_compliance_reason_code": "RETURN_NON_COMPLIANT_MISSING_ITEM", "order_line_id": "OR01-A-2" } ] } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "id": "string", "return_lines": [ { "compliant": true, "non_compliance_additional_info": "string", "non_compliance_reason_code": "RETURN_NON_COMPLIANT_MISSING_ITEM", "order_line_id": "string" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/RT26_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6", "message": "Return is in invalid state" }, { "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a", "message": "The compliance has not been specified on the following order lines: OL-46" } ], "return_success": [ { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "id": "string", "message": "string" } ], "return_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT26_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_WRITE" ] } ], "summary": "RT26 - Mark a return as compliant or non compliant", "tags": [ "Returns" ] } }, "/api/returns/close": { "put": { "description": "
    Description
    \n\nLimited to 100 returns at a time\n\n
    \nError Codes\n\n| Code | Description |\n|------|-------------|\n| RETURN_DUPLICATE_ID | The returns list contains duplicate return IDs |\n| RETURN_HANDLED_BY_OPERATOR | This return is handled by the operator and cannot be managed by the shop |\n| RETURN_INVALID_STATE | The return is not in the expected state for this operation |\n| RETURN_NOT_ENABLED | Returns are not enabled |\n| RETURN_NOT_FOUND | The requested return does not exist |\n| VALIDATION_ERROR | Input validation failed |\n\n
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each closure of one or multiple returns
    \n
    Maximum usage: At each closure of one or multiple returns
    \n
    ", "operationId": "RT27", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6" }, { "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a" }, { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/RT27_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "code": "RETURN_INVALID_STATE", "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6", "message": "Return is in state IN_PROGRESS, expected RECEIVED or NO_RECEPTION" }, { "code": "RETURN_NOT_FOUND", "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a", "message": "The return does not exist." } ], "return_success": [ { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "code": "string", "id": "string", "message": "string" } ], "return_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT27_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_WRITE" ] } ], "summary": "RT27 - Mark a return as closed", "tags": [ "Returns" ] } }, "/api/returns/cancel": { "put": { "description": "
    Description
    \n\nLimited to 100 returns at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each cancellation of one or multiple returns
    \n
    Maximum usage: At each cancellation of one or multiple returns
    \n
    ", "operationId": "RT29", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "returns": [ { "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6" }, { "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a" }, { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "returns": [ { "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/RT29_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_errors": [ { "id": "af1a537d-3f8a-4bb4-a69c-08df8395ece6", "message": "Return is in invalid state" }, { "id": "df7b1144-0789-46f9-a0db-bb79c2c7de3a", "message": "The return does not exist." } ], "return_success": [ { "id": "b77907cb-f72e-4f69-aac3-14df566311de" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_errors": [ { "id": "string", "message": "string" } ], "return_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT29_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_WRITE" ] } ], "summary": "RT29 - Mark a return as canceled", "tags": [ "Returns" ] } }, "/api/returns/return-labels": { "post": { "description": "
    Description
    \n\nGenerate return labels for a given list of return IDs\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each customer return label request
    \n
    Maximum usage: At each customer return label request
    \n
    ", "operationId": "RT51", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_labels": [ { "carrier_code": null, "carrier_service_code": null, "label_options": { "qr_code": false }, "label_selection_mode": "CHEAPEST", "package": { "dimensions": { "height": 15, "length": 30, "unit": "cm", "width": 20 }, "weight": { "unit": "kg", "value": 1.5 } }, "return_id": "6c074a94-e9b5-42ea-afc3-e4d5198fa679", "shipping_from": { "city": "London", "contact_name": "Store Manager", "contact_phone": "+44 20 1234 5678", "country_iso_code": "GB", "state": null, "street_1": "123 High Street", "street_2": null, "zip_code": "SW1A 1AA" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_labels": [ { "carrier_code": "string", "carrier_service_code": "string", "label_options": { "qr_code": true }, "label_selection_mode": "CHEAPEST", "package": { "dimensions": { "height": 0, "length": 0, "unit": "string", "width": 0 }, "weight": { "unit": "string", "value": 0 } }, "return_id": "string", "shipping_from": { "city": "string", "contact_name": "string", "contact_phone": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" } } ] } } }, "schema": { "$ref": "#/components/schemas/RT51_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "return_label_errors": [ { "message": "return [e2132cd6-891f-4fc5-a7d5-79fa2c9fabf8] is in an incompatible state for label generation", "return_id": "e2132cd6-891f-4fc5-a7d5-79fa2c9fabf8" } ], "return_label_successes": [ { "return_id": "5cfc665e-8624-4b8d-9758-19b836cb16dd" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "return_label_errors": [ { "error_message": "string", "return_id": "string" } ], "return_label_successes": [ { "return_id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT51_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_WRITE" ] } ], "summary": "RT51 - Create return labels", "tags": [ "Returns" ] }, "get": { "description": "
    Description
    \n\nRetrieve the list of the return label requests along with their details and states\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each customer return label request
    \n
    Maximum usage: At each customer return label request
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • date_created (Default) - Sort by label creation date (asc by default)
    \n\n
    ", "operationId": "RT52", "parameters": [ { "description": "Return id for filtering. This parameter can be supplied multiple times (return_id=58fd00d1-4ea4-453e-9a56-ec28c5c156ea&return_id=3071c162-dcd9-414b-a39d-ac3165f29453...). Limited to 100 values.", "explode": true, "in": "query", "name": "return_id", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Return label state for filtering. This parameter can be supplied multiple times (label_state=PENDING&label_state=CREATED...)", "explode": true, "in": "query", "name": "label_state", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "CREATED", "FAILED" ] } }, "style": "form" }, { "description": "Filter labels created on or after the given date.", "explode": true, "in": "query", "name": "date_created_from", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter labels created on or before the given date.", "explode": true, "in": "query", "name": "date_created_to", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter labels last updated on or after the given date.", "explode": true, "in": "query", "name": "last_updated_from", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter labels last updated on or before the given date.", "explode": true, "in": "query", "name": "last_updated_to", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "date_created": "2023-03-28T09:34:42Z", "errors": [ { "code": "string", "message": "string" } ], "estimated_cost": { "amount": 0, "currency_iso_code": "AED" }, "files": { "label": { "file_type": "string", "url": "string" }, "qr_code": { "file_type": "string", "url": "string" } }, "label_state": "PENDING", "last_updated": "2023-03-28T09:34:42Z", "return_id": "string", "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_service_code": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/RT52_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_RETURN_READ" ] } ], "summary": "RT52 - List return labels", "tags": [ "Returns" ] } }, "/api/shops/documents": { "get": { "description": "
    Description
    \n\nYou must specify at least one of the following parameters: shop_ids, updated_since\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each display of a page that includes documents from a store (for example: during the KYC process)
    \n
    Maximum usage: At each display of a page that includes documents from a store (for example: during the KYC process)
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shop_documents": [ { "date_uploaded": "2019-03-27T14:43:06Z", "file_name": "legal.jpeg", "id": 2002, "type": "LEGAL_DOC" }, { "date_uploaded": "2019-03-27T14:44:07Z", "file_name": "card.jpeg", "id": 2004, "type": "ID_CARD" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shop_documents": [ { "date_uploaded": "2023-03-28T09:34:42Z", "file_name": "string", "id": 0, "type": "string" } ], "total_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/S30_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_DOCUMENT_READ" ] } ], "summary": "S30 - List shop's documents", "tags": [ "Stores" ] }, "post": { "description": "
    Description
    \n\nDocument filenames must be distinct and there can be only one file per document type.
    Only documents of the following types are supported: csv, doc, docx, gif, html, jpeg, latex, mp4, odp, odc, odg, ods, odt, pdf, png, pps, ppsx, ppt, pptx, quicktime, rtf, text, tiff, xls, xlsx, xml, zip
    You can upload a maximum of 50 business documents for each shop. These documents are not order related documents.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each business document upload to a shop
    \n
    Maximum usage: 50 business documents per call
    \n
    ", "operationId": "S32", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "files": [ "string" ], "shop_documents": { "shop_documents": [ { "file_name": "string", "type_code": "string" } ] } } } }, "schema": { "type": "object", "properties": { "files": { "type": "array", "description": "Files to upload", "items": { "type": "string", "format": "binary" } }, "shop_documents": { "$ref": "#/components/schemas/S32_Request_MultipartFormData_ShopDocuments", "description": "A descriptor associated to the files" } }, "required": [ "files", "shop_documents" ] } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "errors_count": 1, "shop_documents": [ { "errors": [ { "code": "valid_shop_document.type", "field": "type_code", "message": "Unable to retrieve document's type from the given code" } ], "input": { "file_name": "proof-of-identity-38294.pdf", "type_code": "IDENTIFICATION_DOCUMENTX" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "documents": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ] } ], "errors_count": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/S32_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_DOCUMENT_WRITE" ] } ], "summary": "S32 - Upload business documents to associate with a shop", "tags": [ "Stores" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/shops/documents \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'files=@path/to/file' \\\n -F 'shop_documents=\"{\\\"shop_documents\\\":[{\\\"file_name\\\":\\\"string\\\",\\\"type_code\\\":\\\"string\\\"}]}\";type=application/json'\n" } ] } }, "/api/shops/documents/download": { "get": { "description": "
    Description
    \n\n
    • It is mandatory to specify either the shop_ids or the document_ids.
    • If a list of document identifiers is specified only these documents are downloaded.
      • If more than one document id is specified, the documents will be wrapped in a ZIP archive
      • If only one document id is specified the document will not be zipped
    • If no document identifiers is specified, all the shop documents will be downloaded.
      Use a list of shop document type codes to retrieve specific types from your shop.
      In this case, the output of the API will always be a ZIP archive even if there is only one document to retrieve.

    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

    \n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: After each S30 call, when you want to download documents from a store
    \n
    Maximum usage: After each S30 call, when you want to download documents from a store
    \n
    ", "operationId": "S31", "parameters": [ { "description": "A list of document identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids", "explode": true, "in": "query", "name": "document_ids", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "A list of document type codes (separated by a comma)", "explode": true, "in": "query", "name": "type_codes", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/octet-stream": { "examples": { "application/octet-stream-auto": { "summary": "Complete example with value types (application/octet-stream)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHOP_DOCUMENT_READ" ] } ], "summary": "S31 - Download documents for one or multiple shops", "tags": [ "Stores" ] } }, "/api/shops/documents/{document_id}": { "delete": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: At each document deletion from one store
    \n
    Maximum usage: At each document deletion from one store
    \n
    ", "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", "required": false, "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": "S33 - Delete a shop document", "tags": [ "Stores" ] } }, "/api/seller-billing-cycles": { "get": { "description": "
    Description
    \n\nThis resource uses seek pagination. The maximum allowed value for parameter limit is 1000.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day and as many times as there are billing cycle pages returned
    \n
    Maximum usage: Once per day and as many times as there are billing cycle pages returned
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (asc by default)
    \n\n
    ", "operationId": "SBC11", "parameters": [ { "description": "Currency for filtering. This parameter can be supplied multiple times.", "explode": true, "in": "query", "name": "currency", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "AED", "ARS", "AUD", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "GEL", "GTQ", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "JOD", "JPY", "KES", "KRW", "KWD", "LKR", "MAD", "MGA", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "THB", "TWD", "UAH", "USD", "UYU", "UZS", "VND", "ZAR" ] } }, "style": "form" }, { "description": "Creation date used as the maximum value for filtering (inclusive)", "explode": true, "in": "query", "name": "end_date", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "NOT_SPECIFIED", "MANGOPAY", "MIRAKL_PAYOUT", "OPERATOR" ] } }, "style": "form" }, { "description": "Pay-out state for filtering. This parameter can be supplied multiple times.", "explode": true, "in": "query", "name": "pay_out_state", "required": false, "schema": { "type": "array", "default": [ "TO_PAY", "FAILED", "PAID" ], "items": { "type": "string", "default": "TO_PAY,FAILED,PAID", "enum": [ "TO_PAY", "PAID", "FAILED" ] } }, "style": "form" }, { "description": "Creation date used as the minimum value for filtering (inclusive)", "explode": true, "in": "query", "name": "start_date", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "amount_transferred_to_operator": 1046.59, "amount_transferred_to_seller": 4545.2, "currency_iso_code": "EUR", "date_created": "2014-01-01T00:00:00Z", "id": "a5b77ee5-f5c2-4efc-ab94-8366ee781598", "pay_out": { "reference": "bank-ref", "state": "PAID" }, "pay_out_psp_code": "MANGOPAY", "shop": { "shop_corporate_name": "Ceasar Shop", "shop_id": 12, "shop_name": "The Shop", "shop_operator_internal_id": "op1234" }, "summary": { "total_commissions_excl_tax": -474.1, "total_commissions_incl_tax": -889.24, "total_fee_excl_tax": 5, "total_fee_incl_tax": 5, "total_fee_operator_remitted_excl_tax": -5, "total_fee_operator_remitted_incl_tax": -5, "total_mirakl_ads_credit_excl_tax": 0, "total_mirakl_ads_credit_incl_tax": 0, "total_mirakl_ads_debit_excl_tax": 0, "total_mirakl_ads_debit_incl_tax": 0, "total_non_payable_orders_excl_tax": 0, "total_non_payable_orders_incl_tax": 0, "total_operator_paid_shipping_charges_excl_tax": -20, "total_operator_paid_shipping_charges_incl_tax": -24, "total_operator_remitted_taxes": -24, "total_other_credits_excl_tax": -92.9, "total_other_credits_incl_tax": -93.9, "total_other_invoices_excl_tax": 0, "total_other_invoices_incl_tax": 0, "total_payable_orders_excl_tax": 20400, "total_payable_orders_incl_tax": 22776.54, "total_purchase_taxes": 0, "total_refund_commissions_excl_tax": 54.47, "total_refund_commissions_incl_tax": 59.92, "total_refund_fee_excl_tax": -3, "total_refund_fee_incl_tax": -3, "total_refund_fee_operator_remitted_excl_tax": 3, "total_refund_fee_operator_remitted_incl_tax": 3, "total_refund_non_payable_orders_excl_tax": 0, "total_refund_non_payable_orders_incl_tax": 0, "total_refund_operator_paid_shipping_charges_excl_tax": 0, "total_refund_operator_paid_shipping_charges_incl_tax": 0, "total_refund_operator_remitted_taxes": 0, "total_refund_orders_excl_tax": -4070, "total_refund_orders_incl_tax": -4186.72, "total_refund_payable_orders_excl_tax": -4070, "total_refund_payable_orders_incl_tax": -4186.72, "total_refund_purchase_taxes": 0, "total_seller_fees_on_orders_excl_tax": -5, "total_seller_fees_on_orders_incl_tax": -6, "total_seller_penalty_fees_excl_tax": 0, "total_seller_penalty_fees_incl_tax": 0, "total_subscription_excl_tax": -55.85, "total_subscription_incl_tax": -67.37 } }, { "amount_transferred_to_operator": 955.69, "amount_transferred_to_seller": 4545.2, "currency_iso_code": "NGN", "date_created": "2014-01-01T00:00:00Z", "id": "98665be1-ce69-4ab6-8d93-b8dfd3e67404", "pay_out": { "state": "TO_PAY" }, "pay_out_psp_code": "NOT_SPECIFIED", "shop": { "shop_corporate_name": "Ben Store SA", "shop_id": 3432, "shop_name": "Ben Store", "shop_operator_internal_id": "DFJKDSFSD" }, "summary": { "total_commissions_excl_tax": -474.1, "total_commissions_incl_tax": -889.24, "total_fee_excl_tax": 10, "total_fee_incl_tax": 10, "total_fee_operator_remitted_excl_tax": -10, "total_fee_operator_remitted_incl_tax": -10, "total_mirakl_ads_credit_excl_tax": 0, "total_mirakl_ads_credit_incl_tax": 0, "total_mirakl_ads_debit_excl_tax": 0, "total_mirakl_ads_debit_incl_tax": 0, "total_non_payable_orders_excl_tax": 0, "total_non_payable_orders_incl_tax": 0, "total_operator_paid_shipping_charges_excl_tax": -10, "total_operator_paid_shipping_charges_incl_tax": -12, "total_operator_remitted_taxes": -12, "total_other_credits_excl_tax": -9, "total_other_credits_incl_tax": -10, "total_other_invoices_excl_tax": 1, "total_other_invoices_incl_tax": 1, "total_payable_orders_excl_tax": 20400, "total_payable_orders_incl_tax": 22776.54, "total_purchase_taxes": 0, "total_refund_commissions_excl_tax": 54.47, "total_refund_commissions_incl_tax": 59.92, "total_refund_fee_excl_tax": -2, "total_refund_fee_incl_tax": -2, "total_refund_fee_operator_remitted_excl_tax": 2, "total_refund_fee_operator_remitted_incl_tax": 2, "total_refund_non_payable_orders_excl_tax": 0, "total_refund_non_payable_orders_incl_tax": 0, "total_refund_operator_paid_shipping_charges_excl_tax": 0, "total_refund_operator_paid_shipping_charges_incl_tax": 0, "total_refund_operator_remitted_taxes": 0, "total_refund_orders_excl_tax": -4070, "total_refund_orders_incl_tax": -4186.72, "total_refund_payable_orders_excl_tax": -4070, "total_refund_payable_orders_incl_tax": -4186.72, "total_refund_purchase_taxes": 0, "total_seller_fees_on_orders_excl_tax": -10, "total_seller_fees_on_orders_incl_tax": -12, "total_seller_penalty_fees_excl_tax": -5, "total_seller_penalty_fees_incl_tax": -6, "total_subscription_excl_tax": -55.85, "total_subscription_incl_tax": -67.37 } }, { "amount_transferred_to_operator": 0, "amount_transferred_to_seller": 0, "currency_iso_code": "EUR", "date_created": "2026-06-01T00:00:00Z", "id": "81a36c97-6cc1-44ec-93e7-f55e06e6a6c6", "pay_out": { "state": "TO_PAY" }, "pay_out_psp_code": "NOT_SPECIFIED", "shop": { "shop_id": 2, "shop_name": "SuperShop" }, "summary": { "total_commissions_excl_tax": 0, "total_commissions_incl_tax": 0, "total_fee_excl_tax": 0, "total_fee_incl_tax": 0, "total_fee_operator_remitted_excl_tax": 0, "total_fee_operator_remitted_incl_tax": 0, "total_mirakl_ads_credit_excl_tax": 0, "total_mirakl_ads_credit_incl_tax": 0, "total_mirakl_ads_debit_excl_tax": 0, "total_mirakl_ads_debit_incl_tax": 0, "total_non_payable_orders_excl_tax": 0, "total_non_payable_orders_incl_tax": 0, "total_operator_paid_shipping_charges_excl_tax": 0, "total_operator_paid_shipping_charges_incl_tax": 0, "total_operator_remitted_taxes": 0, "total_other_credits_excl_tax": 0, "total_other_credits_incl_tax": 0, "total_other_invoices_excl_tax": 0, "total_other_invoices_incl_tax": 0, "total_payable_orders_excl_tax": 0, "total_payable_orders_incl_tax": 0, "total_purchase_taxes": 0, "total_refund_commissions_excl_tax": 0, "total_refund_commissions_incl_tax": 0, "total_refund_fee_excl_tax": 0, "total_refund_fee_incl_tax": 0, "total_refund_fee_operator_remitted_excl_tax": 0, "total_refund_fee_operator_remitted_incl_tax": 0, "total_refund_non_payable_orders_excl_tax": 0, "total_refund_non_payable_orders_incl_tax": 0, "total_refund_operator_paid_shipping_charges_excl_tax": 0, "total_refund_operator_paid_shipping_charges_incl_tax": 0, "total_refund_operator_remitted_taxes": 0, "total_refund_orders_excl_tax": 0, "total_refund_orders_incl_tax": 0, "total_refund_payable_orders_excl_tax": 0, "total_refund_payable_orders_incl_tax": 0, "total_refund_purchase_taxes": 0, "total_seller_fees_on_orders_excl_tax": 0, "total_seller_fees_on_orders_incl_tax": 0, "total_seller_penalty_fees_excl_tax": 0, "total_seller_penalty_fees_incl_tax": 0, "total_subscription_excl_tax": 0, "total_subscription_incl_tax": 0 } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "amount_transferred_to_operator": 0, "amount_transferred_to_seller": 0, "currency_iso_code": "AED", "date_created": "2023-03-28T09:34:42Z", "id": "string", "pay_out": { "failure_reason": "INCOMPLETE_KYC", "reference": "string", "state": "TO_PAY", "transaction_date": "2023-03-28T09:34:42Z" }, "pay_out_psp_code": "NOT_SPECIFIED", "payment_voucher_number": "string", "shop": { "shop_corporate_name": "string", "shop_id": 0, "shop_model": "MARKETPLACE", "shop_name": "string", "shop_operator_internal_id": "string" }, "summary": { "total_commissions_excl_tax": 0, "total_commissions_incl_tax": 0, "total_fee_excl_tax": 0, "total_fee_incl_tax": 0, "total_fee_operator_remitted_excl_tax": 0, "total_fee_operator_remitted_incl_tax": 0, "total_mirakl_ads_credit_excl_tax": 0, "total_mirakl_ads_credit_incl_tax": 0, "total_mirakl_ads_debit_excl_tax": 0, "total_mirakl_ads_debit_incl_tax": 0, "total_non_payable_orders_excl_tax": 0, "total_non_payable_orders_incl_tax": 0, "total_operator_paid_shipping_charges_excl_tax": 0, "total_operator_paid_shipping_charges_incl_tax": 0, "total_operator_remitted_taxes": 0, "total_other_credits_excl_tax": 0, "total_other_credits_incl_tax": 0, "total_other_invoices_excl_tax": 0, "total_other_invoices_incl_tax": 0, "total_payable_orders_excl_tax": 0, "total_payable_orders_incl_tax": 0, "total_purchase_taxes": 0, "total_refund_commissions_excl_tax": 0, "total_refund_commissions_incl_tax": 0, "total_refund_fee_excl_tax": 0, "total_refund_fee_incl_tax": 0, "total_refund_fee_operator_remitted_excl_tax": 0, "total_refund_fee_operator_remitted_incl_tax": 0, "total_refund_non_payable_orders_excl_tax": 0, "total_refund_non_payable_orders_incl_tax": 0, "total_refund_operator_paid_shipping_charges_excl_tax": 0, "total_refund_operator_paid_shipping_charges_incl_tax": 0, "total_refund_operator_remitted_taxes": 0, "total_refund_orders_excl_tax": 0, "total_refund_orders_incl_tax": 0, "total_refund_payable_orders_excl_tax": 0, "total_refund_payable_orders_incl_tax": 0, "total_refund_purchase_taxes": 0, "total_seller_fees_on_orders_excl_tax": 0, "total_seller_fees_on_orders_incl_tax": 0, "total_seller_penalty_fees_excl_tax": 0, "total_seller_penalty_fees_incl_tax": 0, "total_subscription_excl_tax": 0, "total_subscription_incl_tax": 0 } } ], "next_page_token": "string", "previous_page_token": "string" } } }, "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": "SBC11 - List seller billing cycles", "tags": [ "Invoicing and Accounting" ] } }, "/api/shipping/zones": { "get": { "description": "
    Description
    \n\nResults are sorted by index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipping_zones": [ { "code": "DOM1", "description": "Domestic 1", "label": "Domestic 1" }, { "code": "DOM2", "description": "Domestic 2", "label": "Domestic 2" }, { "code": "INT1", "description": "International 1", "label": "International 1" }, { "code": "INT2", "description": "International 2", "label": "International 2" }, { "code": "INT3", "description": "International 3", "label": "International 3" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipping_zones": [ { "code": "string", "description": "string", "label": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/SH11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ] } ], "summary": "SH11 - List all active shipping zones", "tags": [ "Platform Settings" ] } }, "/api/shipping/types": { "get": { "description": "
    Description
    \n\nResults are sorted by index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipping_types": [ { "click_and_collect": false, "code": "STD", "delivery_by_operator": false, "description": "Standard Delivery (3-5 days)", "ignore_lead_time_to_ship": true, "label": "Standard", "mandatory_tracking": true, "standard_code": "CU_ADD-STD" }, { "click_and_collect": false, "code": "EXP", "delivery_by_operator": false, "description": "Express Delivery (1-2 days)", "label": "Express", "mandatory_tracking": true, "standard_code": "CU_ADD-EXP" }, { "click_and_collect": false, "code": "NEX", "delivery_by_operator": true, "description": "Next day delivery (ordered before 5 pm)", "label": "Next day delivery", "mandatory_tracking": true, "standard_code": "CU_ADD-NEXT_DAY" }, { "click_and_collect": true, "code": "CLC", "delivery_by_operator": false, "description": "Collect In Store", "label": "Click & collect", "mandatory_tracking": false, "standard_code": "CLC_OPERATOR-STD" }, { "click_and_collect": false, "code": "PIP", "delivery_by_operator": false, "description": "Pickup Point", "label": "Pickup Point", "mandatory_tracking": false, "standard_code": "PICK_UP_POINT-STD" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipping_types": [ { "click_and_collect": true, "code": "string", "delivery_by_operator": true, "description": "string", "ignore_lead_time_to_ship": true, "label": "string", "mandatory_tracking": true, "standard_code": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/SH12_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ] } ], "summary": "SH12 - List all active shipping methods", "tags": [ "Platform Settings" ] } }, "/api/shipping/carriers": { "get": { "description": "
    Description
    \n\nResults are sorted alphabetically by carrier label\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Read More
    \n\n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "carriers": [ { "code": "FED", "label": "Fed Ex", "standard_code": "FED", "tracking_url": "http://www.fedex.com/Tracking?action=track&tracknumbers={trackingId}" }, { "code": "UPS", "label": "UPS", "standard_code": "UPS", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}" }, { "code": "DHL", "label": "DHL", "standard_code": "DHL", "tracking_url": "http://www.dhl.co.uk/en/express/tracking.html?AWB={trackingId}&brand=DHL" }, { "code": "DPD", "label": "DPD", "standard_code": "DPD", "tracking_url": "http://www.dpd.co.uk/apps/tracking/?parcel={trackingId}" }, { "code": "TNT", "label": "TNT", "standard_code": "TNT", "tracking_url": "http://www.tnt.com/webtracker/tracking.do?navigation=1&searchType=CON&respLang=en&genericSiteIdent=.&cons={trackingId}" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "carriers": [ { "code": "string", "label": "string", "standard_code": "string", "tracking_url": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/SH21_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ] } ], "summary": "SH21 - List all carriers", "tags": [ "Platform Settings" ] } }, "/api/shipping/logistic_classes": { "get": { "description": "
    Description
    \n\nResults are sorted by index, set in the back-office\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per day
    \n
    Maximum usage: Once per day
    \n
    Localization
    \n\n

    This resource supports locale parameter (see documentation)

    Localized output fields will be highlighted with an icon:

    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "logistic_classes": [ { "code": "S", "description": "Small", "label": "Small" }, { "code": "M", "description": "Medium", "label": "Medium" }, { "code": "L", "description": "Large", "label": "Large" }, { "code": "OV1", "description": "Oversize 1", "label": "Oversize 1" }, { "code": "OV2", "description": "Oversize 2", "label": "Oversize 2" }, { "code": "FREE", "description": "Free Shipping", "label": "Free Shipping" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "logistic_classes": [ { "code": "string", "description": "string", "label": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/SH31_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_SHIPPING_SETTINGS_READ" ] } ], "summary": "SH31 - List all logistic classes", "tags": [ "Platform Settings" ] } }, "/api/shipping/configuration/shop": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every week
    \n
    Maximum usage: Every hour
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "delivery_times": [ { "delivery_time": { "earliest_days": 1, "latest_days": 2 }, "set_by": "SHOP", "shipping_type_code": "NEX", "shipping_zone_code": "DOM1" }, { "delivery_time": { "earliest_days": 2, "latest_days": 4 }, "set_by": "OPERATOR", "shipping_type_code": "STD", "shipping_zone_code": "DOM1" } ], "last_updated_date": "2026-02-24T17:09:09.920Z", "lead_time_to_ship": { "default_value": 3, "shop_value": 1 }, "order_cut_off_times": [ { "cut_off_time": "07:30:00Z", "set_by": "SHOP", "shipping_type_code": "NEX" }, { "cut_off_time": "02:00:00Z", "set_by": "OPERATOR", "shipping_type_code": "STD" } ], "order_free_shipping": false, "shop_id": "3" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "delivery_times": [ { "delivery_time": { "earliest_days": 0, "latest_days": 0 }, "set_by": "OPERATOR", "shipping_type_code": "string", "shipping_zone_code": "string" } ], "last_updated_date": "2023-03-28T09:34:42Z", "lead_time_to_ship": { "default_value": 0, "shop_value": 0 }, "order_cut_off_times": [ { "cut_off_time": "string", "is_required": true, "set_by": "OPERATOR", "shipping_type_code": "string" } ], "order_free_shipping": true, "shipping_paid_by_operator": true, "shop_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/SH42_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "SH42 - Get shop shipping configuration", "tags": [ "Platform Settings" ] } }, "/api/shipping/charges/shop": { "get": { "description": "
    Description
    \n\nGet shipping charges and their configuration\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every week
    \n
    Maximum usage: Every hour
    \n
    ", "operationId": "SH52", "parameters": [ { "description": "Retrieve only the shipping charge configurations customized by the seller", "explode": true, "in": "query", "name": "overridden_by_shop", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "configuration": [ { "logistic_class_code": "S", "overridden_by_shop": true, "prices": { "additional_price": 2, "free_shipping_threshold": null, "initial_price": 3, "type": "FIXED_PRICE" }, "shipping_method_code": "STD", "shipping_zone_code": "DOM1" }, { "logistic_class_code": "M", "overridden_by_shop": true, "prices": { "ranges": [ { "price": 5, "threshold": 0 }, { "price": 7, "threshold": 50 }, { "price": 8, "threshold": 100 } ], "type": "ORDER_RANGE" }, "shipping_method_code": "STD", "shipping_zone_code": "DOM1" }, { "logistic_class_code": "L", "overridden_by_shop": true, "prices": { "type": "FREE_SHIPPING" }, "shipping_method_code": "STD", "shipping_zone_code": "DOM1" } ], "currency_iso_code": "EUR", "last_updated_date": "2022-03-03T08:52:10Z", "shop_id": 123 } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "configuration": [ { "logistic_class_code": "string", "overridden_by_shop": true, "prices": { "additional_price": 0, "free_shipping_threshold": 0, "initial_price": 0, "ranges": [ { "price": 0, "threshold": 0 } ], "type": "FIXED_PRICE" }, "shipping_method_code": "string", "shipping_zone_code": "string" } ], "currency_iso_code": "AED", "last_updated_date": "2023-03-28T09:34:42Z", "shop_id": 0 } } }, "schema": { "type": "object", "$ref": "#/components/schemas/SH52_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN" ] } ], "summary": "SH52 - Get shipping charges configured for a shop account", "tags": [ "Platform Settings" ] } }, "/api/shipments": { "post": { "description": "
    Description
    \n\nLimited to 1000 shipments at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each new shipment
    \n
    Maximum usage: On each new shipment
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "invoice_reference": "ABCDEF012345", "order_id": "ORDER_01-A", "shipment_additional_information": [ { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "IUYHJ777-98" }, { "code": "DELIVERY_BILL_DATE", "type": "DATE", "value": "2024-01-01" } ], "shipment_lines": [ { "offer_sku": "OFFER_SKU_1", "package_reference": "package_ref_1", "quantity": 1 }, { "offer_sku": "OFFER_SKU_2", "package_reference": "package_ref_2", "quantity": 3 } ], "shipped": false, "shipping_from": { "warehouse": { "code": "DEFAULT_WAREHOUSE" } }, "tracking": { "carrier_code": "UPS", "carrier_name": "UPS", "carrier_standard_code": "UPS", "tracking_number": "1Z2356F1ZJ98L9733M5", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}" } }, { "invoice_reference": "ABCDEF012345", "order_id": "ORDER_01-A", "shipment_additional_information": null, "shipment_lines": [ { "order_line_id": "ORDER_01-A-1", "package_reference": "package_ref_1", "quantity": 1 }, { "order_line_id": "ORDER_01-A-2", "package_reference": "package_ref_2", "quantity": 3 } ], "shipped": true, "tracking": { "carrier_name": "Custom carrier", "tracking_url": "http://www.customcarrier.com/tracking" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "invoice_reference": "string", "order_id": "string", "shipment_additional_information": [ { "code": "string", "type": "STRING", "value": "object" } ], "shipment_lines": [ { "offer_sku": "string", "order_line_id": "string", "package_reference": "string", "quantity": 0 } ], "shipped": true, "shipping_from": { "warehouse": { "code": "string" } }, "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ] } } }, "schema": { "$ref": "#/components/schemas/ST01_Request" } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipment_errors": [ { "message": "The order status must be 'SHIPPING' but it is 'SHIPPED'.", "order_id": "leadtime-ship02-A" }, { "message": "Shipment quantity is invalid.", "order_id": "7263625-A" } ], "shipment_success": [ { "created_date": "2021-07-06T08:07:22.326Z", "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce", "invoice_reference": "ABCDEF012345", "last_updated_date": null, "order_id": "ORDER_01-A", "payment_details": null, "shipment_additional_information": [ { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "IUYHJ777-98" } ], "shipment_lines": [ { "offer_sku": "OFFER_SKU_01", "order_line_id": "ORDER_01-A-1", "package_reference": "package_ref_1", "quantity": 1 }, { "offer_sku": "OFFER_SKU_02", "order_line_id": "ORDER_01-A-2", "package_reference": "package_ref_2", "quantity": 3 } ], "shipped_date": null, "shipping_from": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "warehouse": { "code": "DEFAULT_WAREHOUSE" } }, "status": "SHIPPING", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_code": "UPS", "carrier_name": "UPS", "carrier_standard_code": "UPS", "last_known_location": null, "milestones": [], "tracking_number": "1Z2356F1ZJ98L9733M5", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}", "validity_status": null } }, { "created_date": "2021-07-06T09:24:36.326Z", "id": "41c1b9b3-820b-4493-ae7c-1b656377b52b", "invoice_reference": null, "last_updated_date": null, "order_id": "ORDER_02-A", "payment_details": null, "shipment_lines": [ { "offer_sku": "OFFER_SKU_01", "order_line_id": "ORDER_02-A-1", "package_reference": "package_ref_1", "quantity": 1 }, { "offer_sku": "OFFER_SKU_02", "order_line_id": "ORDER_02-A-2", "package_reference": "package_ref_2", "quantity": 3 } ], "shipped_date": "2021-07-06T10:24:36.326Z", "shipping_from": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "warehouse": null }, "status": "SHIPPED", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_name": "Custom carrier", "tracking_url": "http://www.customcarrier.com/tracking" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_errors": [ { "message": "string", "order_id": "string" } ], "shipment_success": [ { "created_date": "2023-03-28T09:34:42Z", "id": "string", "invoice_reference": "string", "last_updated_date": "2023-03-28T09:34:42Z", "order_id": "string", "payment_details": { "customer_debited_date": "2023-03-28T09:34:42Z", "transaction_date": "2023-03-28T09:34:42Z", "transaction_number": "string" }, "shipment_additional_information": [ { "code": "string", "type": "STRING" } ], "shipment_lines": [ { "offer_sku": "string", "order_line_id": "string", "package_reference": "string", "quantity": 0 } ], "shipped_date": "2023-03-28T09:34:42Z", "shipping_from": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "warehouse": { "code": "string" } }, "status": "SHIPPING", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_code": "string", "carrier_expected_delivery_date": { "earliest": { "date": "string", "offset": "string", "time": "string" }, "latest": { "date": "string", "offset": "string", "time": "string" } }, "carrier_name": "string", "carrier_standard_code": "string", "last_known_location": { "location": "string", "occurrence_date": { "date": "string", "offset": "string", "time": "string" } }, "milestones": [ { "additional_info": { "occurrence_date": { "date": "string", "offset": "string", "time": "string" }, "type": "DESTINATION_ARRIVAL" }, "occurrence_date": { "date": "string", "offset": "string", "time": "string" }, "type": "IN_TRANSIT" } ], "tracking_number": "string", "tracking_url": "string", "validity_status": "MISSING_TRACKING" } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST01_Response_201" } } }, "description": "Created" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ] } ], "summary": "ST01 - Create shipments", "tags": [ "Multiple shipments" ] }, "put": { "description": "
    Description
    \n\nLimited to 100 shipments at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each update of shipments for one or multiple shipments
    \n
    Maximum usage: At each update of shipments for one or multiple shipments
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "id": "5b2269b6-3918-43bc-9262-fddd815398f3", "shipping_from": { "warehouse": { "code": "WHC1" } } }, { "id": "0e450a4c-704f-4e2c-845a-71b65b4ff16a", "shipping_from": { "warehouse": { "code": "WHC2" } } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "id": "string", "shipping_from": { "warehouse": { "code": "string" } } } ] } } }, "schema": { "$ref": "#/components/schemas/ST07_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipment_errors": [ { "id": "0e450a4c-704f-4e2c-845a-71b65b4ff16a", "message": "Warehouse with code WHC2 does not exist" } ], "shipment_success": [ { "id": "5b2269b6-3918-43bc-9262-fddd815398f3", "shipping_from": { "address": { "city": "Paris", "country_iso_code": "FRA", "state": "Ile de France", "street_1": "12 rue de Lubeck", "street_2": null, "zip_code": "75016" }, "warehouse": { "code": "WHC1" } } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_errors": [ { "id": "string", "message": "string" } ], "shipment_success": [ { "id": "string", "shipping_from": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "warehouse": { "code": "string" } } } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST07_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIPMENT_WRITE" ] } ], "summary": "ST07 - Update shipment shipping origin", "tags": [ "Multiple shipments" ] }, "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: at each shipment page display
    \n
    Maximum usage: at each shipment page display
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (asc by default)
    \n\n
    ", "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form" }, { "description": "Filter shipments updated after the given date.", "explode": true, "in": "query", "name": "last_updated_from", "required": false, "schema": { "type": "string", "format": "date-time" }, "style": "form" }, { "description": "Filter shipments updated before the given date.", "explode": true, "in": "query", "name": "last_updated_to", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "created_date": "2021-06-25T15:28:00.336Z", "id": "4dd549d5-3b5b-4237-a77c-a084359f93fc", "invoice_reference": "ABCDEF012345", "last_updated_date": "2021-07-06T09:24:36.326Z", "order_id": "ORDER_01-A", "payment_details": null, "shipment_lines": [ { "offer_sku": "OFFER_SKU_01", "order_line_id": "ORDER_01-A-1", "package_reference": "package_ref_1", "quantity": 1 }, { "offer_sku": "OFFER_SKU_02", "order_line_id": "ORDER_01-A-2", "package_reference": "package_ref_2", "quantity": 3 } ], "shipped_date": "2021-07-06T10:24:36.326Z", "shipping_from": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "warehouse": { "code": "DEFAULT_WAREHOUSE" } }, "status": "SHIPPED", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_code": "UPS", "carrier_estimated_delivery_date": { "earliest": { "date": "2024-02-12", "offset": "Z", "time": "16:30:00" }, "latest": { "date": "2024-02-14", "offset": "Z", "time": "18:19:42" } }, "carrier_name": "UPS", "carrier_standard_code": "UPS", "last_known_location": { "location": "PARIS", "occurrence_date": { "date": "2024-02-08", "offset": null, "time": null } }, "milestones": [ { "additional_info": { "occurrence_date": { "date": "2023-12-22", "offset": null, "time": "14:25:00" }, "type": "DELIVERY_ATTEMPTED" }, "occurrence_date": { "date": "2024-02-08", "offset": "+02:00", "time": "12:50:00" }, "type": "IN_TRANSIT" }, { "additional_info": { "occurrence_date": { "date": "2023-12-22", "offset": null, "time": "14:25:00" }, "type": "DESTINATION_ARRIVAL" }, "occurrence_date": { "date": "2024-02-08", "offset": null, "time": null }, "type": "OUT_FOR_DELIVERY" }, { "additional_info": null, "occurrence_date": { "date": "2024-02-08", "offset": null, "time": "16:45:10" }, "type": "DELIVERED" } ], "tracking_number": "1315A26", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1315A26", "validity_status": "VERIFIED" } }, { "created_date": "2021-07-01T10:30:00.000Z", "id": "297bf287-37d7-4490-8849-58356602e800", "invoice_reference": "ABCDEF012345", "last_updated_date": "2021-07-06T09:24:36.326Z", "order_id": "ORDER_02-A", "payment_details": null, "shipment_additional_information": [ { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "IUYHJ777-98" } ], "shipment_lines": [ { "offer_sku": "OFFER_SKU_03", "order_line_id": "ORDER_02-A-1", "package_reference": "package_ref_1", "quantity": 10 }, { "offer_sku": "OFFER_SKU_04", "order_line_id": "ORDER_02-A-2", "package_reference": "package_ref_2", "quantity": 2 } ], "shipped_date": "2021-07-06T10:24:36.326Z", "shipping_from": { "address": { "city": "New York City", "country_iso_code": "USA", "state": "New York", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "warehouse": null }, "status": "CLOSED", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_code": null, "carrier_estimated_delivery_date": { "earliest": { "date": "2024-03-10", "offset": null, "time": null }, "latest": { "date": "2024-03-14", "offset": null, "time": "18:19:42" } }, "carrier_name": "La Poste", "carrier_standard_code": null, "last_known_location": { "location": "PARIS", "occurrence_date": { "date": "2024-03-06", "offset": "-02:00", "time": "12:00:02" } }, "milestones": [], "tracking_number": "0AAC590", "tracking_url": "http://www.laposte.com/suivi/0AAC590", "validity_status": "UNVERIFIED" } }, { "created_date": "2021-07-01T10:30:00.000Z", "id": "e47cef257-37d7-4490-8849-58356bc02ea07", "invoice_reference": null, "last_updated_date": "2021-07-06T09:24:36.326Z", "order_id": "ORDER_03-A", "payment_details": null, "shipment_lines": [ { "offer_sku": "OFFER_SKU_03", "order_line_id": "ORDER_03-A-1", "quantity": 10 }, { "offer_sku": "OFFER_SKU_04", "order_line_id": "ORDER_03-A-2", "quantity": 2 } ], "shipped_date": null, "status": "SHIPPING", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_code": null, "carrier_estimated_delivery_date": null, "carrier_name": "La Poste", "carrier_standard_code": null, "last_known_location": { "location": "LONDON", "occurrence_date": { "date": "2024-02-08", "offset": "+01:00", "time": "06:07:08" } }, "milestones": [], "tracking_number": "0AAC590", "tracking_url": "http://www.laposte.com/suivi/0AAC590", "validity_status": "UNCOVERED" } }, { "created_date": "2022-07-25T15:28:00.336Z", "id": "d6ce3a1d-6c21-4535-bce7-bd44777823d4", "invoice_reference": null, "last_updated_date": "2022-08-06T09:24:36.326Z", "order_id": "ORDER_04-A", "payment_details": { "customer_debited_date": "2022-07-25T15:28:00.336Z", "transaction_date": "2022-07-25T15:28:00.336Z", "transaction_number": "tx-123456" }, "shipment_lines": [ { "offer_sku": "OFFER_SKU_01", "order_line_id": "ORDER_04-A-1", "quantity": 1 } ], "shipped_date": "2022-08-06T10:24:36.326Z", "status": "SHIPPED", "status_customer_debit": "DEBIT_OK", "tracking": { "carrier_code": "UPS", "carrier_estimated_delivery_date": null, "carrier_name": "UPS", "carrier_standard_code": "UPS", "last_known_location": { "location": "LONDON", "occurrence_date": { "date": "2024-02-08", "offset": null, "time": null } }, "milestones": [], "tracking_number": "1315A32", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1315A32", "validity_status": null } } ], "next_page_token": "bGltaXQ9MTAmYWZ0ZXI9MjAxOS0wOC0xMlQxMDowMzoyMy43NzNaJmFmdGVyPU1JUi1RTDNXVE1DSi1BJmFmdGVyPTEmc29ydD1kYXRlQ3JlYXRlZCxBU0M=", "previous_page_token": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "created_date": "2023-03-28T09:34:42Z", "id": "string", "invoice_reference": "string", "last_updated_date": "2023-03-28T09:34:42Z", "order_id": "string", "payment_details": { "customer_debited_date": "2023-03-28T09:34:42Z", "transaction_date": "2023-03-28T09:34:42Z", "transaction_number": "string" }, "shipment_additional_information": [ { "code": "string", "type": "STRING" } ], "shipment_lines": [ { "offer_sku": "string", "order_line_id": "string", "package_reference": "string", "quantity": 0 } ], "shipped_date": "2023-03-28T09:34:42Z", "shipping_from": { "address": { "city": "string", "country_iso_code": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "warehouse": { "code": "string" } }, "status": "SHIPPING", "status_customer_debit": "NO_DEBIT", "tracking": { "carrier_code": "string", "carrier_expected_delivery_date": { "earliest": { "date": "string", "offset": "string", "time": "string" }, "latest": { "date": "string", "offset": "string", "time": "string" } }, "carrier_name": "string", "carrier_standard_code": "string", "last_known_location": { "location": "string", "occurrence_date": { "date": "string", "offset": "string", "time": "string" } }, "milestones": [ { "additional_info": { "occurrence_date": { "date": "string", "offset": "string", "time": "string" }, "type": "DESTINATION_ARRIVAL" }, "occurrence_date": { "date": "string", "offset": "string", "time": "string" }, "type": "IN_TRANSIT" } ], "tracking_number": "string", "tracking_url": "string", "validity_status": "MISSING_TRACKING" } } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_READ" ] } ], "summary": "ST11 - List shipments", "tags": [ "Multiple shipments" ] } }, "/api/shipments/delete": { "put": { "description": "
    Description
    \n\nLimited to 1000 shipments at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each shipment deletion
    \n
    Maximum usage: On each shipment deletion
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "id": "e2055970-dd6c-4d66-b005-096d6e6e0f30" }, { "id": "89174558-2845-44ef-bd57-78db027947f7" }, { "id": "14d134a1-eb3a-442c-b16c-05a35486d1bf" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/ST06_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "deletion_errors": [ { "id": "89174558-2845-44ef-bd57-78db027947f7", "message": "Shipment with id '89174558-2845-44ef-bd57-78db027947f7' is not in SHIPPING status and cannot be deleted." }, { "id": "14d134a1-eb3a-442c-b16c-05a35486d1bf", "message": "No shipment with id '14d134a1-eb3a-442c-b16c-05a35486d1bf'" } ], "deletion_success": [ { "id": "e2055970-dd6c-4d66-b005-096d6e6e0f30" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_errors": [ { "id": "string", "message": "string" } ], "shipment_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST06_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIPMENT_DELETE" ] } ], "summary": "ST06 - Delete shipments", "tags": [ "Multiple shipments" ] } }, "/api/shipments/items_to_ship": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 15 minutes
    \n
    Maximum usage: Every 5 minutes
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • shippingDate (Default) - Sort by shipping date (asc by default)
    \n\n
    ", "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "fulfillment": { "center": { "code": "DEFAULT" } }, "order_id": "MIR-YQMLSYUI-B", "references": { "order_reference_for_customer": "ref_customer", "order_reference_for_seller": "ref_seller" }, "shipment_lines": [ { "offer_sku": "4114", "order_line_id": "MIR-YQMLSYUI-B-2", "package_reference": "package_ref_1", "product_title": "Capture Coloured Court Shoe - 11", "quantity": 4 }, { "offer_sku": "4114", "order_line_id": "MIR-YQMLSYUI-B-2", "package_reference": "package_ref_2", "product_title": "Capture Coloured Court Shoe - 11", "quantity": 4 } ], "shipping_address": { "additional_info": null, "city": "New York City", "civility": "M", "company": "LIMARK Company", "company_2": "Other Inf. Company", "country": "USA", "country_iso_code": "USA", "firstname": "smith", "lastname": "Taylor", "state": "Manhattan", "street_1": "113 MacDougal Street", "street_2": "1st floor", "zip_code": "NY 10012" }, "shipping_date": "2022-02-10T08:46:34.353Z", "shipping_deadline": "2022-02-15T23:59:59.999Z", "shipping_type_code": "CLC", "shipping_type_standard_code": "CLC_OPERATOR-STD" } ], "next_page_token": null, "previous_page_token": null } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "fulfillment": { "center": { "code": "string" } }, "order_id": "string", "references": { "order_reference_for_customer": "string", "order_reference_for_seller": "string" }, "shipment_lines": [ { "offer_sku": "string", "order_line_id": "string", "package_description": "string", "package_reference": "string", "product_title": "string", "quantity": 0 } ], "shipping_address": { "additional_info": "string", "city": "string", "civility": "string", "company": "string", "company_2": "string", "country": "string", "country_iso_code": "AFG", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street_1": "string", "street_2": "string", "zip_code": "string" }, "shipping_date": "2023-03-28T09:34:42Z", "shipping_deadline": "2023-03-28T09:34:42Z", "shipping_type_code": "string", "shipping_type_standard_code": "string" } ], "next_page_token": "string", "previous_page_token": "string" } } }, "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": "ST12 - List items to ship", "tags": [ "Multiple shipments" ] } }, "/api/shipments/tracking": { "post": { "description": "
    Description
    \n\nIf the carrier is not registered, the complete tracking url can be provided. Limited to 1000 shipments at a time.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each shipment tracking info update
    \n
    Maximum usage: On each shipment tracking info update
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce", "tracking": { "carrier_code": "UPS", "carrier_name": "UPS", "carrier_standard_code": "UPS", "tracking_number": "1Z2356F1ZJ98L9733M5", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}" } }, { "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723", "tracking": { "carrier_code": "UPS", "carrier_name": "UPS", "carrier_standard_code": "UPS", "tracking_number": "1Z2356F1ZJ98L9733M5", "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}" } } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "id": "string", "tracking": { "carrier_code": "string", "carrier_name": "string", "carrier_standard_code": "string", "tracking_number": "string", "tracking_url": "string" } } ] } } }, "schema": { "$ref": "#/components/schemas/ST23_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipment_errors": [ { "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce", "message": "No shipment with id 'f40bf65e-a320-41d3-878c-36ce9e1144ce'." } ], "shipment_success": [ { "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_errors": [ { "id": "string", "message": "string" } ], "shipment_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST23_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_TRACKING_WRITE" ] } ], "summary": "ST23 - Update carrier tracking information for shipments", "tags": [ "Multiple shipments" ] } }, "/api/shipments/ship": { "put": { "description": "
    Description
    \n\nLimited to 1000 shipments at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each shipment shipping
    \n
    Maximum usage: On each shipment shipping
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce" }, { "id": "c8ca3759-a81b-4abe-afd0-93a418e83ae8" }, { "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/ST24_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipment_errors": [ { "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723", "message": "No shipment with id 'ff341bfe-ebeb-4211-848b-77fcbcd91723'." } ], "shipment_success": [ { "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce" }, { "id": "c8ca3759-a81b-4abe-afd0-93a418e83ae8" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_errors": [ { "id": "string", "message": "string" } ], "shipment_success": [ { "id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST24_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ] } ], "summary": "ST24 - Validate shipments as shipped", "tags": [ "Multiple shipments" ] } }, "/api/shipments/ready_for_pick_up": { "put": { "description": "
    Description
    \n\nLimited to 1000 shipments at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: On each shipment ready to pick up
    \n
    Maximum usage: On each shipment ready to pick up
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce" }, { "id": "c8ca3759-a81b-4abe-afd0-93a418e83ae8" }, { "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "id": "string" } ] } } }, "schema": { "$ref": "#/components/schemas/ST26_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipment_errors": [ { "id": "ff341bfe-ebeb-4211-848b-77fcbcd91723", "message": "No shipment with id 'ff341bfe-ebeb-4211-848b-77fcbcd91723'." } ], "shipment_success": [ { "id": "f40bf65e-a320-41d3-878c-36ce9e1144ce" }, { "id": "c8ca3759-a81b-4abe-afd0-93a418e83ae8" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_errors": [ { "id": "string", "message": "string" } ], "shipment_success": [ { "id": "string" } ] } } }, "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": "ST26 - Validate shipments as ready to pick up", "tags": [ "Multiple shipments" ] } }, "/api/shipments/additional_information": { "put": { "description": "
    Description
    \n\nLimited to 100 shipments at a time\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: At each update of shipments for one or multiple shipments
    \n
    Maximum usage: At each update of shipments for one or multiple shipments
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipments": [ { "id": "4dd549d5-3b5b-4237-a77c-a084359f93z", "shipment_additional_information": [ { "code": "IMEI", "type": "STRING", "value": "38021999921000" }, { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "invalid value with spaces" } ] }, { "id": "245365B0-D003-4DB7-B23F-5C0A48E93E53", "shipment_additional_information": [ { "code": "DELIVERY_BILL_DATE", "type": "DATE", "value": "2024-01-01" }, { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "IUYHJ777-98" } ] } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipments": [ { "id": "string", "shipment_additional_information": [ { "code": "string", "type": "STRING", "value": "object" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/ST31_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "shipment_update_errors": [ { "errors": [ { "code": "invalid.value", "field": "shipmentAdditionalInfoCommands[1].value", "message": "The shipment additional info ''DELIVERY_BILL_ID'' does not match the expected format" } ], "shipment_id": "4dd549d5-3b5b-4237-a77c-a084359f93z" } ], "shipment_update_success": [ { "shipment_additional_information": [ { "code": "DELIVERY_BILL_DATE", "type": "DATE", "value": "2024-01-01" }, { "code": "DELIVERY_BILL_ID", "type": "STRING", "value": "IUYHJ777-98" } ], "shipment_id": "245365B0-D003-4DB7-B23F-5C0A48E93E5" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "shipment_update_errors": [ { "errors": [ { "code": "string", "field": "string", "message": "string" } ], "shipment_id": "string" } ], "shipment_update_success": [ { "shipment_additional_information": [ { "code": "string", "type": "STRING", "value": "object" } ], "shipment_id": "string" } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/ST31_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_ORDER_SHIP" ] } ], "summary": "ST31 - Update shipment additional information", "tags": [ "Multiple shipments" ] } }, "/api/offers/stock/imports": { "post": { "description": "
    Description
    \n\nImport a .csv file to update stock for offers, either globally or per warehouse.
    \nReturns an import identifier to track the status of the import and retrieve an error report if applicable.
    \n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Every 5 minutes when stock needs updating
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "STO01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "multipart/form-data-auto": { "summary": "Complete example with value types (multipart/form-data)", "value": { "file": "string" } } }, "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Import CSV file to upload. Use multipart/form-data with name file.
    \nCsv format:
    \n
      \n
    • \"offer-sku\";\"quantity\";\"warehouse-code\";\"update-delete\"
      • \n
        \n
      • 1 line = 1 offer quantity
        • \n
      • List quantities per warehouse for the same offer together
        • \n
      • If warehouse-code is not provided, the quantity provided for the offer-sku will be considered as a global one
        • \n
      \n
    \n" } }, "required": [ "file" ] } } } }, "responses": { "201": { "content": { "application/json": { "examples": { "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "import_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/STO01_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_STOCK_WRITE" ] } ], "summary": "STO01 - Import a stock file", "tags": [ "Offers" ], "x-codeSamples": [ { "lang": "cURL", "source": "curl -i -X POST \\\n https://your-instance.mirakl.net/api/offers/stock/imports \\\n -H 'Content-Type: multipart/form-data' \\\n -F 'file=@path/to/file'\n" } ] } }, "/api/offers/stock/imports/{import_id}/status": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: After each STO01 call, every 5 minutes
    \n
    Maximum usage: Once every 15 seconds
    \n
    Read More
    \n\n
    ", "operationId": "STO02", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "date_created": "2023-03-28T09:34:42Z", "has_error_report": true, "import_id": "string", "lines_in_error": 0, "lines_in_success": 0, "shop_id": 0, "status": "WAITING" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/STO02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_STOCK_WRITE" ] } ], "summary": "STO02 - Get information and statistics about an offer stock import", "tags": [ "Offers" ] } }, "/api/offers/stock/imports/{import_id}/error_report": { "get": { "description": "
    Description
    \n\nOnly returns the lines in error.
    \nThe first column contains the line number in error. The second column contains the error reason.
    \nThe returned file is ready to be reimported after the values have been fixed.
    \nOffer quantities that were submitted in the stock import but don't appear in the error report were successfully imported.\n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: After each STO02 call, every 5 minutes
    \n
    Maximum usage: Once per minute
    \n
    Read More
    \n\n
    ", "operationId": "STO03", "parameters": [ { "description": "Import identifier", "explode": false, "in": "path", "name": "import_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "text/csv": { "examples": { "text/csv-auto": { "summary": "Complete example with value types (text/csv)", "value": "string" } }, "schema": { "type": "string", "format": "binary" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_OFFER_STOCK_WRITE" ] } ], "summary": "STO03 - Get the error report for a stock import in CSV format", "tags": [ "Offers" ] } }, "/api/sellerpayment/transactions_logs": { "get": { "description": "
    Description
    \n\nThis resource uses seek pagination. The maximum allowed value for parameter limit is 2000.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: 20 times per day
    \n
    Maximum usage: 20 times per min, 60 times per hour
    \n
    Pagination
    \n\n

    This resource supports seek pagination (see documentation)

    \n\n
    Sort fields
    \n\nsort field can have the following values:
    • dateCreated (Default) - Sort by creation date (desc by default)
    • lastUpdated - Sort by last updated date (Recommended) (desc by default)
    \n\n
    ", "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", "required": false, "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", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Creation date" }, "style": "form" }, { "description": "Creation date", "explode": true, "in": "query", "name": "date_created_to", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Creation date" }, "style": "form" }, { "description": "Transaction date", "explode": true, "in": "query", "name": "transaction_date_from", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Transaction date" }, "style": "form" }, { "description": "Transaction date", "explode": true, "in": "query", "name": "transaction_date_to", "required": false, "schema": { "type": "string", "format": "date-time", "description": "Transaction date" }, "style": "form" }, { "description": "Last updated date", "explode": true, "in": "query", "name": "last_updated_from", "required": false, "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", "required": false, "schema": { "type": "array", "description": "Payment state. This parameter can be supplied multiple times.", "items": { "type": "string", "enum": [ "PENDING", "PAYABLE", "PAID", "NOT_APPLICABLE", "RESERVE" ] }, "maxItems": 100, "minItems": 0 }, "style": "form" }, { "description": "Transaction type. This parameter can be supplied multiple times.", "explode": true, "in": "query", "name": "transaction_type", "required": false, "schema": { "type": "array", "description": "Transaction type. This parameter can be supplied multiple times.", "items": { "type": "string", "enum": [ "MANUAL_CREDIT", "MANUAL_CREDIT_VAT", "MANUAL_INVOICE", "MANUAL_INVOICE_VAT", "INVOICEABLE_ONE_OFF_DEBIT", "INVOICEABLE_ONE_OFF_DEBIT_TAX", "INVOICEABLE_ONE_OFF_CREDIT", "INVOICEABLE_ONE_OFF_CREDIT_TAX", "INVOICEABLE_MIRAKL_ADS_DEBIT", "INVOICEABLE_MIRAKL_ADS_DEBIT_TAX", "INVOICEABLE_MIRAKL_ADS_CREDIT", "INVOICEABLE_MIRAKL_ADS_CREDIT_TAX", "ORDER_AMOUNT", "ORDER_AMOUNT_TAX", "ORDER_SHIPPING_AMOUNT", "ORDER_SHIPPING_AMOUNT_TAX", "COMMISSION_FEE", "COMMISSION_VAT", "REFUND_ORDER_AMOUNT", "REFUND_ORDER_AMOUNT_TAX", "REFUND_ORDER_SHIPPING_AMOUNT", "REFUND_ORDER_SHIPPING_AMOUNT_TAX", "REFUND_COMMISSION_FEE", "REFUND_COMMISSION_VAT", "SUBSCRIPTION_FEE", "SUBSCRIPTION_VAT", "OPERATOR_REMITTED_ORDER_AMOUNT_TAX", "OPERATOR_REMITTED_ORDER_SHIPPING_AMOUNT_TAX", "OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX", "OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX", "OPERATOR_PAID_ORDER_SHIPPING_AMOUNT", "OPERATOR_PAID_ORDER_SHIPPING_AMOUNT_TAX", "OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT", "OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT_TAX", "PAYMENT", "PURCHASE_COMMISSION_FEE", "PURCHASE_SHIPPING_COMMISSION_FEE", "PURCHASE_ORDER_AMOUNT_TAX", "PURCHASE_ORDER_SHIPPING_AMOUNT_TAX", "REFUND_PURCHASE_COMMISSION_FEE", "REFUND_PURCHASE_SHIPPING_COMMISSION_FEE", "REFUND_PURCHASE_ORDER_AMOUNT_TAX", "REFUND_PURCHASE_ORDER_SHIPPING_AMOUNT_TAX", "ORDER_FEE_AMOUNT", "OPERATOR_REMITTED_ORDER_FEE_AMOUNT", "REFUND_ORDER_FEE_AMOUNT", "OPERATOR_REMITTED_REFUND_ORDER_FEE_AMOUNT", "PURCHASE_FEE_COMMISSION_FEE", "REFUND_PURCHASE_FEE_COMMISSION_FEE", "RESERVE_FUNDING", "RESERVE_SETTLEMENT", "SELLER_FEE_ON_ORDER", "SELLER_FEE_ON_ORDER_TAX", "SELLER_PENALTY_FEE", "SELLER_PENALTY_FEE_TAX" ] }, "maxItems": 100, "minItems": 0 }, "style": "form" }, { "description": "Accounting document number", "explode": true, "in": "query", "name": "accounting_document_number", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Order id. This parameter can be supplied multiple times.", "explode": true, "in": "query", "name": "order_id", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "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", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Shop model. This parameter can be supplied multiple times.", "explode": true, "in": "query", "name": "shop_model", "required": false, "schema": { "type": "array", "description": "Shop model. This parameter can be supplied multiple times.", "items": { "type": "string", "enum": [ "MARKETPLACE", "DROPSHIP", "ONE_CREDITOR" ] } }, "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", "required": false, "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", "enum": [ "NOT_SPECIFIED", "MANGOPAY", "MIRAKL_PAYOUT", "OPERATOR" ] } }, "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", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "accounting_document_creation_date": "2026-10-26T13:25:58.502Z", "accounting_document_number": "000000000999", "amount": -0.5, "amount_credited": 0, "amount_debited": 0.5, "balance": -8.5, "currency_iso_code": "EUR", "date_created": "2026-10-26T13:25:58.518Z", "entities": { "one_off_item": { "description": "Test one-off item", "operation_date": "2026-03-08", "quantity": 2, "references": [ { "type": "INTERNAL", "value": "ONEOFF_REF1" } ], "unit_price": 100 }, "shop_tax": { "code": "TAXDEFAULT", "rate": 20 } }, "id": "b48df332-b088-4111-9a6c-cb1ebc3926d9", "last_updated": "2026-10-26T13:25:58.518Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -8.5, "seller_billing_cycle_id": "da94f4ec-9447-4856-a637-2aad467acdeb", "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "INVOICEABLE_ONE_OFF_DEBIT_TAX" }, { "accounting_document_creation_date": "2026-10-26T13:25:58.502Z", "accounting_document_number": "000000000999", "amount": -5, "amount_credited": 0, "amount_debited": 5, "balance": -8, "currency_iso_code": "EUR", "date_created": "2026-10-26T13:25:58.518Z", "entities": { "one_off_item": { "description": "Test one-off item", "operation_date": "2026-03-08", "quantity": 2, "references": [ { "type": "INTERNAL", "value": "ONEOFF_REF1" } ], "unit_price": 100 } }, "id": "93cf3ea2-cd0b-4566-be4a-5a782ff4ee52", "last_updated": "2026-10-26T13:25:58.518Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -8, "seller_billing_cycle_id": "da94f4ec-9447-4856-a637-2aad467acdeb", "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "INVOICEABLE_ONE_OFF_DEBIT" }, { "accounting_document_creation_date": "2026-10-26T13:25:58.502Z", "accounting_document_number": "000000000999", "amount": -1, "amount_credited": 0, "amount_debited": 1, "balance": -3, "currency_iso_code": "EUR", "date_created": "2026-10-26T13:25:58.514Z", "entities": { "domain": "PRODUCT", "fee": { "cancelations": [ { "id": "CANCEL1" }, { "id": "CANCEL2" } ], "code": "CANCELLATION_FEE" }, "order": { "commercial_id": "ORDER1", "creation_date": "2016-02-03T02:00:00.108Z", "id": "ORDER1-A", "payment_info": { "imprint_number": "IMPRINT-1315", "payment_type": "CARD" }, "references": { "order_reference_for_customer": "customer_ref", "order_reference_for_seller": "seller_ref" } } }, "id": "278fa0f7-d97b-467a-9b0a-795b5610c32f", "last_updated": "2026-10-26T13:25:58.514Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -3, "seller_billing_cycle_id": "da94f4ec-9447-4856-a637-2aad467acdeb", "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "SELLER_PENALTY_FEE" }, { "accounting_document_creation_date": "2026-10-26T13:25:58.502Z", "accounting_document_number": "000000000999", "amount": -3, "amount_credited": 0, "amount_debited": 3, "balance": -2, "currency_iso_code": "EUR", "date_created": "2026-10-26T13:25:58.507Z", "entities": { "debit": { "id": "DEBIT1" }, "domain": "PRODUCT", "order": { "commercial_id": "ORDER1", "creation_date": "2016-02-03T02:00:00.108Z", "id": "ORDER1-A", "payment_info": { "imprint_number": "IMPRINT-1315", "payment_type": "CARD" }, "references": { "order_reference_for_customer": "customer_ref", "order_reference_for_seller": "seller_ref" } }, "order_line": { "id": "ORDER1-A-1" }, "refund": { "id": "REFUND1" }, "shipment": { "id": "SHIPMENT1" }, "shop_tax": { "code": "TAX2", "rate": 12.45 }, "transaction_info": { "date": "2016-05-10T12:02:03Z", "number": "TRANSACTION1" } }, "id": "e94d724c-9f79-4875-898c-ee1a46111449", "last_updated": "2026-10-26T13:25:58.507Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -2, "seller_billing_cycle_id": "da94f4ec-9447-4856-a637-2aad467acdeb", "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "COMMISSION_VAT" }, { "accounting_document_creation_date": "2026-10-26T13:25:58.502Z", "accounting_document_number": "000000000999", "amount": 1, "amount_credited": 1, "amount_debited": 0, "balance": 1, "currency_iso_code": "EUR", "date_created": "2026-10-26T13:25:58.507Z", "entities": { "debit": { "id": "DEBIT1" }, "domain": "PRODUCT", "order": { "commercial_id": "ORDER1", "creation_date": "2016-02-03T02:00:00.108Z", "id": "ORDER1-A", "payment_info": { "imprint_number": "IMPRINT-1315", "payment_type": "CARD" }, "references": { "order_reference_for_customer": "customer_ref", "order_reference_for_seller": "seller_ref" } }, "order_line": { "id": "ORDER1-A-1" }, "order_tax": { "code": "TAX1", "rate": 0.2 }, "refund": { "id": "REFUND1" }, "shipment": { "id": "SHIPMENT1" }, "transaction_info": { "date": "2016-05-10T12:02:03Z", "number": "TRANSACTION1" } }, "id": "f8fabeab-71e5-4299-9c20-9679379ff181", "last_updated": "2026-10-26T13:25:58.507Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PENDING", "payment_voucher_number": "000001", "psp_balance": 1, "seller_billing_cycle_id": "da94f4ec-9447-4856-a637-2aad467acdeb", "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "REFUND_ORDER_AMOUNT" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "data": [ { "accounting_document_creation_date": "2023-03-28T09:34:42Z", "accounting_document_id": "string", "accounting_document_number": "string", "amount": 0, "amount_credited": 0, "amount_debited": 0, "balance": 0, "currency_iso_code": "string", "date_created": "2023-03-28T09:34:42Z", "entities": { "channel": { "code": "string" }, "debit": { "id": "string" }, "domain": "string", "fee": { "cancelations": [ { "id": "string" } ], "code": "string", "refunds": [ { "id": "string" } ] }, "manual_accounting_document": { "emission_date": "2023-03-28T09:34:42Z", "number": "string" }, "one_off_item": { "description": "string", "operation_date": "string", "quantity": 0, "references": [ { "type": "string", "value": "string" } ], "unit_price": 0 }, "order": { "commercial_id": "string", "creation_date": "2023-03-28T09:34:42Z", "id": "string", "payment_info": { "imprint_number": "string", "payment_type": "string" }, "references": { "order_reference_for_customer": "string", "order_reference_for_seller": "string" } }, "order_fee": { "code": "string" }, "order_line": { "id": "string" }, "order_tax": { "code": "string", "rate": 0 }, "refund": { "id": "string" }, "shipment": { "id": "string" }, "shop_tax": { "code": "string", "rate": 0 }, "transaction_info": { "date": "2023-03-28T09:34:42Z", "number": "string" } }, "id": "string", "last_updated": "2023-03-28T09:34:42Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PENDING", "psp_balance": 0, "seller_billing_cycle_id": "string", "type": "MANUAL_CREDIT" } ], "next_page_token": "string", "previous_page_token": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/TL02_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ACCOUNTANCY", "ROLE_PARTNER_TRANSACTION_LOG_READ" ] } ], "summary": "TL02 - List transaction lines", "tags": [ "Invoicing and Accounting" ] } }, "/api/sellerpayment/transactions_logs/async": { "post": { "description": "
    Description
    \n\nThe export is asynchronous. Export status can be retrieved by calling TL04.\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage:
    once per day
    \n
    Maximum usage:
    once per day
    \n
    ", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "Transaction_date_from": "2021-11-12T02:34:00Z", "megabytes_per_chunk": "10", "shop_domain": [ "PRODUCT" ], "transaction_type": [ "MANUAL_CREDIT" ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "accounting_document_id": "string", "accounting_document_number": "string", "date_created_from": "2023-03-28T09:34:42Z", "date_created_to": "2023-03-28T09:34:42Z", "format": "JSON", "items_per_chunk": 0, "last_updated_from": "2023-03-28T09:34:42Z", "megabytes_per_chunk": 0, "order_id": [ "string" ], "order_line_id": [ "string" ], "order_reference_for_customer": [ "string" ], "order_reference_for_seller": [ "string" ], "other_reference": [ "string" ], "pay_out_psp_codes": [ "NOT_SPECIFIED" ], "payment_state": [ "PENDING" ], "payment_voucher_number": "string", "seller_billing_cycle_id": [ "string" ], "shop_domain": [ "string" ], "shop_id": 0, "shop_model": [ "MARKETPLACE" ], "transaction_date_from": "2023-03-28T09:34:42Z", "transaction_date_to": "2023-03-28T09:34:42Z", "transaction_type": [ "MANUAL_CREDIT" ] } } }, "schema": { "$ref": "#/components/schemas/TL03_Request" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "tracking_id": "f3ab1003-5f61-4a6f-b044-a76635d5a425" } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "tracking_id": "string" } } }, "schema": { "type": "object", "$ref": "#/components/schemas/TL03_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ACCOUNTANCY", "ROLE_PARTNER_TRANSACTION_LOG_READ" ] } ], "summary": "TL03 - Export transaction lines JSON file asynchronously", "tags": [ "Invoicing and Accounting" ] } }, "/api/sellerpayment/transactions_logs/async/status/{tracking_id}": { "get": { "description": "
    Description
    \n\nRetrieve the status for an TL03 transaction log export.
    \nWhen the export is complete, the URLs to retrieve the files are returned.\n\n\n
    \n
    Call Frequency
    \n\n
    Recommended usage: Once per minute until you get an error or a success
    \n
    Maximum usage: Every 10 seconds
    \n
    ", "operationId": "TL04", "parameters": [ { "description": "The asynchronous transaction log export id", "explode": false, "in": "path", "name": "tracking_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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "last_updated": "2026-10-26T13:25:58.525Z", "status": "COMPLETED", "urls": [ "http://api.mirakl.net/api/sellerpayment/transactions_logs/export/async/file/8648ca91-f5c0-4815-9bac-7564124d5203?file=0.json", "http://api.mirakl.net/api/sellerpayment/transactions_logs/export/async/file/8648ca91-f5c0-4815-9bac-7564124d5203?file=1.json" ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "error": { "code": "string", "detail": "string" }, "last_updated": "2023-03-28T09:34:42Z", "status": "string", "urls": [ "string" ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/TL04_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ACCOUNTANCY", "ROLE_PARTNER_TRANSACTION_LOG_READ" ] } ], "summary": "TL04 - Poll the status of an asynchronous transaction log export (TL03)", "tags": [ "Invoicing and Accounting" ] } }, "/dynamic-url/The+URL+is+retrieved+from+TL04+output/TL05": { "get": { "description": "
    Description
    \n\nRetrieve each chunk of an transaction logs export file via the URL generated once the asynchronous transaction logs export is complete\n\n
    \n
    ", "operationId": "TL05", "parameters": [ { "description": "The asynchronous transaction log export id", "explode": false, "in": "path", "name": "tracking_id", "required": true, "schema": { "type": "string" }, "style": "simple" }, { "description": "The asynchronous transaction log export chunk file", "explode": true, "in": "query", "name": "file", "required": true, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "data": [ { "accounting_document_creation_date": "2016-02-03T02:00:00.108Z", "accounting_document_number": "000000000999", "amount": -0.5, "amount_credited": 0, "amount_debited": 0.5, "balance": -8.5, "currency_iso_code": "EUR", "date_created": "2016-02-02T02:00:00.108Z", "entities": { "one_off_item": { "description": "Test one-off item", "operation_date": "2026-03-08", "quantity": 2, "references": [ { "type": "INTERNAL", "value": "ONEOFF_REF1" } ], "unit_price": 100 }, "shop_tax": { "code": "TAXDEFAULT", "rate": 20 } }, "id": "8648ca91-f5c0-4815-9bac-7564124d5203", "last_updated": "2016-02-03T02:00:00.108Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -8.5, "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "INVOICEABLE_ONE_OFF_DEBIT_TAX" }, { "accounting_document_creation_date": "2016-02-03T02:00:00.108Z", "accounting_document_number": "000000000999", "amount": -5, "amount_credited": 0, "amount_debited": 5, "balance": -8, "currency_iso_code": "EUR", "date_created": "2016-02-02T02:00:00.108Z", "entities": { "one_off_item": { "description": "Test one-off item", "operation_date": "2026-03-08", "quantity": 2, "references": [ { "type": "INTERNAL", "value": "ONEOFF_REF1" } ], "unit_price": 100 } }, "id": "8648ca91-f5c0-4815-9bac-7564124d5203", "last_updated": "2016-02-03T02:00:00.108Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -8, "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "INVOICEABLE_ONE_OFF_DEBIT" }, { "accounting_document_creation_date": "2016-02-03T02:00:00.108Z", "accounting_document_number": "000000000999", "amount": -1, "amount_credited": 0, "amount_debited": 1, "balance": -3, "currency_iso_code": "EUR", "date_created": "2016-02-02T02:00:00.108Z", "entities": { "domain": "PRODUCT", "fee": { "cancelations": [ { "id": "CANCEL1" }, { "id": "CANCEL2" } ], "code": "CANCELLATION_FEE" }, "order": { "commercial_id": "ORDER1", "creation_date": "2016-02-03T02:00:00.108Z", "id": "ORDER1-A", "payment_info": { "imprint_number": "IMPRINT-1315", "payment_type": "CARD" }, "references": { "order_reference_for_customer": "customer_ref", "order_reference_for_seller": "seller_ref" } } }, "id": "8648ca91-f5c0-4815-9bac-7564124d5203", "last_updated": "2016-02-03T02:00:00.108Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -3, "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "SELLER_PENALTY_FEE" }, { "accounting_document_creation_date": "2016-02-03T02:00:00.108Z", "accounting_document_number": "000000000999", "amount": -3, "amount_credited": 0, "amount_debited": 3, "balance": -2, "currency_iso_code": "EUR", "date_created": "2016-02-02T02:00:00.108Z", "entities": { "debit": { "id": "DEBIT1" }, "domain": "PRODUCT", "order": { "commercial_id": "ORDER1", "creation_date": "2016-02-03T02:00:00.108Z", "id": "ORDER1-A", "payment_info": { "imprint_number": "IMPRINT-1315", "payment_type": "CARD" }, "references": { "order_reference_for_customer": "customer_ref", "order_reference_for_seller": "seller_ref" } }, "order_line": { "id": "ORDER1-A-1" }, "refund": { "id": "REFUND1" }, "shop_tax": { "code": "TAX2", "rate": 12.45 }, "transaction_info": { "date": "2016-05-10T12:02:03Z", "number": "TRANSACTION1" } }, "id": "8648ca91-f5c0-4815-9bac-7564124d5203", "last_updated": "2016-02-03T02:00:00.108Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PAYABLE", "payment_voucher_number": "000001", "psp_balance": -2, "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "COMMISSION_VAT" }, { "accounting_document_creation_date": "2016-02-03T02:00:00.108Z", "accounting_document_number": "000000000999", "amount": 1, "amount_credited": 1, "amount_debited": 0, "balance": 1, "currency_iso_code": "EUR", "date_created": "2016-02-02T02:00:00.108Z", "entities": { "debit": { "id": "DEBIT1" }, "domain": "PRODUCT", "order": { "commercial_id": "ORDER1", "creation_date": "2016-02-03T02:00:00.108Z", "id": "ORDER1-A", "payment_info": { "imprint_number": "IMPRINT-1315", "payment_type": "CARD" }, "references": { "order_reference_for_customer": "customer_ref", "order_reference_for_seller": "seller_ref" } }, "order_line": { "id": "ORDER1-A-1" }, "order_tax": { "code": "TAX1", "rate": 0.2 }, "refund": { "id": "REFUND1" }, "transaction_info": { "date": "2016-05-10T12:02:03Z", "number": "TRANSACTION1" } }, "id": "8648ca91-f5c0-4815-9bac-7564124d5203", "last_updated": "2016-02-03T02:00:00.108Z", "pay_out_psp_code": "NOT_SPECIFIED", "payment_state": "PENDING", "payment_voucher_number": "000001", "psp_balance": 1, "shop": { "domains": [ "PRODUCT" ], "id": 1, "model": "MARKETPLACE", "operator_internal_id": "OPERATOR-SHOP-1" }, "type": "REFUND_ORDER_AMOUNT" } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": "string" } }, "schema": { "type": "object", "format": "binary", "$ref": "#/components/schemas/TL05_Response_200_Ext_FileStructure" } }, "application/x-ndjson": { "examples": { "application/x-ndjson-auto": { "summary": "Complete example with value types (application/x-ndjson)", "value": "string" } }, "schema": { "type": "object", "format": "binary", "$ref": "#/components/schemas/TL05_Response_200_ApplicationXNdjson_Ext_FileStructure" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ACCOUNTANCY", "ROLE_PARTNER_TRANSACTION_LOG_READ" ] } ], "summary": "TL05 - Retrieve transaction logs files once asynchronous transaction logs export is complete (TL04)", "tags": [ "Invoicing and Accounting" ] } }, "/api/version": { "get": { "description": "
    Description
    \n\nUse this endpoint to check that Mirakl Platform is up.
    You can ignore the response body that is subject to change, checking the response code is enough.\n\n
    \n
    ", "operationId": "V01", "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "description": "OK" } }, "summary": "V01 - Health Check endpoint", "tags": [ "Platform Settings" ] } }, "/api/values_lists": { "get": { "description": "
    \n
    Call Frequency
    \n\n
    Recommended usage: Every hour
    \n
    Maximum usage: Every hour
    \n
    Read More
    \n\n
    ", "operationId": "VL11", "parameters": [ { "description": "The operator's values list code. If not specified, all values lists are retrieved", "explode": true, "in": "query", "name": "code", "required": false, "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", "required": false, "schema": { "type": "integer", "format": "int64" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "application/json-0": { "summary": "Example with business values (application/json)", "value": { "values_lists": [ { "code": "Jewellery", "label": "Bijoux", "label_translations": [ { "locale": "en", "value": "Jewellery" }, { "locale": "fr", "value": "Bijoux" } ], "values": [ { "code": "Accessories", "label": "Accessoires", "label_translations": [ { "locale": "en", "value": "Accessories" }, { "locale": "fr", "value": "Accessoires" } ] }, { "code": "Bracelets", "label": "Bracelets", "label_translations": [ { "locale": "en", "value": "Bracelets" }, { "locale": "fr", "value": "Bracelets" } ] }, { "code": "Necklaces", "label": "Colliers", "label_translations": [ { "locale": "en", "value": "Necklaces" }, { "locale": "fr", "value": "Colliers" } ] }, { "code": "Rings", "label": "Anneaux", "label_translations": [ { "locale": "en", "value": "Rings" }, { "locale": "fr", "value": "Anneaux" } ] } ] } ] } }, "application/json-auto": { "summary": "Complete example with value types (application/json)", "value": { "values_lists": [ { "code": "string", "label": "string", "label_translations": [ { "locale": "string", "value": "string" } ], "values": [ { "code": "string", "label": "string", "label_translations": [ { "locale": "string", "value": "string" } ] } ] } ] } } }, "schema": { "type": "object", "$ref": "#/components/schemas/VL11_Response_200" } } }, "description": "OK" } }, "security": [ { "Shop-API-Key": [ "ROLE_SHOP_ADMIN", "ROLE_PARTNER_PRODUCT_CONFIGURATION_READ" ] } ], "summary": "VL11 - Get information about operator's value lists", "tags": [ "Products" ] } } }, "servers": [ { "description": "URL to be replaced by your Mirakl instance URL", "url": "https://your-instance.mirakl.net" } ], "x-group-parameters": true }