{ "components" : { "schemas" : { "AF01_Response_200" : { "type" : "object", "properties" : { "additional_fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AF01_Response_200_AdditionalFields" } } } }, "AF01_Response_200_AdditionalFields" : { "type" : "object", "properties" : { "accepted_values" : { "type" : "array", "description" : "The list of accepted values for this additional field. This field is only present for additional fields of type 'LIST'", "items" : { "type" : "string" } }, "channels" : { "type" : "array", "description" : "The list of channels using this additional field. This field is only present for additional fields linked to a 'SHOP' entity.", "items" : { "type" : "string" } }, "code" : { "type" : "string", "description" : "Additional field code" }, "description" : { "type" : "string", "description" : "The description of the additional field." }, "entity" : { "type" : "string", "description" : "The object on which the additional field applies" }, "label" : { "type" : "string", "description" : "Additional field label" }, "models" : { "type" : "array", "description" : "The list of platform models using this additional field. This field is only present for additional fields linked to a 'SHOP' entity.", "items" : { "type" : "string" } }, "regex" : { "type" : "string", "description" : "The regular expression that is used to validate the value value of this field.
This field is only present for additional fields of type 'REGEX'." }, "required" : { "type" : "boolean", "description" : "Whether or not this additionnal field will be required" }, "shop_permission" : { "type" : "string", "description" : "The shop permission field determines how Shops are allowed to use a Custom field." }, "type" : { "type" : "string", "description" : "Additional field type:" } } }, "CH11_Response_200" : { "type" : "object", "properties" : { "channels" : { "type" : "array", "description" : "List of channels", "items" : { "$ref" : "#/components/schemas/CH11_Response_200_Channels" } } } }, "CH11_Response_200_Channels" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Channel code" }, "description" : { "type" : "string", "description" : "Channel description" }, "label" : { "type" : "string", "description" : "Channel label" } } }, "CUR01_Response_200" : { "type" : "object", "properties" : { "currencies" : { "type" : "array", "description" : "List of currencies", "items" : { "$ref" : "#/components/schemas/CUR01_Response_200_Currencies" } } } }, "CUR01_Response_200_Currencies" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Currency code" }, "label" : { "type" : "string", "description" : "Currency label" }, "platform_default" : { "type" : "boolean", "description" : "Default currency of the platform" } } }, "DO01_Response_200" : { "type" : "object", "properties" : { "documents" : { "type" : "array", "description" : "Document types", "items" : { "$ref" : "#/components/schemas/DO01_Response_200_Documents" } } } }, "DO01_Response_200_Documents" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Type code" }, "description" : { "type" : "string", "description" : "Type description" }, "entity" : { "type" : "string", "description" : "Entity type linked to the document type" }, "label" : { "type" : "string", "description" : "Type label" }, "mime_types" : { "type" : "array", "description" : "Authorized mime types", "items" : { "type" : "string" } }, "models" : { "type" : "array", "description" : "The list of platform models on which this document type is available. This field is only present for document types linked to a 'SHOP' entity.", "items" : { "type" : "string" } } } }, "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." } } }, "DR11_Response_200_Data" : { "type" : "object", "properties" : { "currency_iso_code" : { "type" : "string", "description" : "The currency used for the accounting document request." }, "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." }, "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." }, "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." }, "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", "description" : "The total amount for the accounting document, excluding taxes." }, "total_amount_including_taxes" : { "type" : "number", "description" : "The total amount for the accounting document, including taxes." }, "total_tax_amount" : { "type" : "number", "description" : "The total tax amount for the accounting document." }, "type" : { "type" : "string", "description" : "The accounting document request type." } } }, "DR11_Response_200_Data_DocumentDetails" : { "type" : "object", "properties" : { "format" : { "type" : "string", "description" : "The document 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" } }, "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_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." } } }, "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." } } }, "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", "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." } } }, "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" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "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." }, "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." } } }, "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." }, "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." }, "payment_reference" : { "type" : "string", "description" : "The payment reference for bank transfer." } } }, "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" } } }, "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." } } }, "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`." } } }, "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." }, "street_2" : { "type" : "string", "description" : "The second line of the address street." }, "zip_code" : { "type" : "string", "description" : "The address zip code." } } }, "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", "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." } } }, "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" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "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." }, "street_2" : { "type" : "string", "description" : "The second line of the address street." }, "zip_code" : { "type" : "string", "description" : "The address zip code." } } }, "DR11_Response_200_Data_Taxes" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The tax code." }, "rate" : { "type" : "number", "description" : "The tax rate." }, "total_amount" : { "type" : "number", "description" : "The total tax amount, aggregated by tax code and rate." } } }, "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." } } }, "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." }, "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", "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", "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", "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", "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", "description" : "The total price for the accounting document request line." }, "unit_price_excluding_taxes" : { "type" : "number", "description" : "The unit price excluding taxes for the accounting document request line (after promotions)." } } }, "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", "description" : "The total eco-contribution amount." }, "unit_amount" : { "type" : "number", "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." } } }, "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." } } }, "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 } } }, "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 } } }, "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." } } }, "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." } } }, "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 } } }, "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 } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "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." } } }, "DR12_Response_200_Data_FeesExcludingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The fee amount.", "minimum" : 0 }, "code" : { "type" : "string", "description" : "The fee code." }, "label" : { "type" : "string", "description" : "The fee label." } } }, "DR12_Response_200_Data_Order" : { "type" : "object", "properties" : { "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." } } }, "DR12_Response_200_Data_OrderLine" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The order line identifier." } } }, "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." } } }, "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." } } }, "DR12_Response_200_Data_ProductCreditCancel" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "DR12_Response_200_Data_ProductCreditCancelAdjustment" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "DR12_Response_200_Data_ProductCreditCancelCommercialGesture" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "DR12_Response_200_Data_ProductCreditRefund" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "DR12_Response_200_Data_ProductCreditRefundAdjustment" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "DR12_Response_200_Data_ProductCreditRefundCommercialGesture" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "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" } } } }, "DR12_Response_200_Data_ProductDebit_Promotions" : { "type" : "object", "properties" : { "deduced_amount" : { "type" : "number", "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." } } }, "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." } } }, "DR12_Response_200_Data_PurchaseOrderCredit" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DR12_Response_200_Data" } ] }, "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" } } } }, "DR12_Response_200_Data_PurchaseOrderDebit_Promotions" : { "type" : "object", "properties" : { "deduced_amount" : { "type" : "number", "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." } } }, "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." } } }, "DR12_Response_200_Data_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The tax amount." }, "code" : { "type" : "string", "description" : "The tax code." }, "rate" : { "type" : "number", "description" : "The tax rate." } } }, "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." } } }, "DR12_Response_200_Data_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The tax amount." }, "code" : { "type" : "string", "description" : "The tax code." }, "rate" : { "type" : "number", "description" : "The tax rate." } } }, "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 } } }, "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", "description" : "The total document amount (excluding taxes)" }, "total_tax_amount" : { "type" : "number", "description" : "The total tax amount of the document" } } }, "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" } } } }, "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" } } }, "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" } } }, "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", "description" : "The total document amount (excluding taxes)" }, "total_tax_amount" : { "type" : "number", "description" : "The total tax amount of the document" } } }, "H11_Response_200" : { "type" : "object", "properties" : { "hierarchies" : { "type" : "array", "description" : "List of hierarchies", "items" : { "$ref" : "#/components/schemas/H11_Response_200_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" } } }, "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" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Accounting document creation date" }, "details" : { "type" : "array", "description" : "Accounting details", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_Details" } }, "due_date" : { "type" : "string", "format" : "date-time", "description" : "Due date for the payment of the accounting document" }, "id" : { "type" : "string", "description" : "Accounting document identifier (use it for draft document)" }, "invoice_id" : { "type" : "integer", "format" : "int64", "description" : "Accounting document identifier (present if the accounting document is issued)" }, "issue_date" : { "type" : "string", "format" : "date-time", "description" : "Issue date of an accounting document" }, "issuing_user" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_IssuingUser", "description" : "Accounting document issuing user" }, "pay_out_psp_code" : { "type" : "string", "description" : "PSP code for Pay-out" }, "payment" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_Payment", "description" : "Accounting document payment details" }, "payment_voucher_number" : { "type" : "string", "description" : "The payment voucher number" }, "shop_address" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_ShopAddress", "description" : "Shop address" }, "shop_corporate_name" : { "type" : "string", "description" : "Shop corporate name if it is a professional shop" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop id" }, "shop_model" : { "type" : "string", "description" : "Shop model" }, "shop_name" : { "type" : "string", "description" : "Shop name" }, "shop_operator_internal_id" : { "type" : "string", "description" : "Operator internal id for the shop" }, "shop_tax_number" : { "type" : "string", "description" : "Shop tax number if it is a professional shop" }, "state" : { "type" : "string", "description" : "Accounting document state" }, "total_amount_excl_taxes" : { "type" : "number", "description" : "Total amount charged to the shop (excluding taxes)" }, "total_amount_incl_taxes" : { "type" : "number", "description" : "Total amount charged to the shop (including taxes)" }, "total_taxes" : { "type" : "array", "description" : "Total taxes", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_TotalTaxes" } }, "type" : { "type" : "string", "description" : "Accounting document type" } } }, "IV01_Response_200_Invoices_AutoInvoice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } ], "description" : "Automatic accounting document", "properties" : { "end_time" : { "type" : "string", "format" : "date-time", "description" : "Ending date of the period for accounting document of type AUTO_INVOICE" }, "payment_info" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo", "description" : "Shop payment information" }, "seller_billing_cycle_id" : { "type" : "string", "description" : "The seller billing cycle identifier" }, "start_time" : { "type" : "string", "format" : "date-time", "description" : "Starting date of the period for accounting document of type AUTO_INVOICE" }, "summary" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_Summary", "description" : "Summary for automatic accounting document" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" : { "type" : "object", "discriminator" : { "mapping" : { "ABA" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba", "AUBSB" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb", "BRAZILIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian", "CANADIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian", "COLOMBIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian", "GUATEMALAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan", "HK" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk", "IBAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban", "INDIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian", "ISRAELI" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli", "JAPANESE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese", "MEXICAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican", "NUBAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban", "NZBSB" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb", "PAYOUT" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout", "PHILIPPINES" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines", "SERBIAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian", "SG" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg", "TAIWANESE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese", "THAI" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai", "UK" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk", "URUGUAYAN" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan", "VIETNAMESE" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese" }, "propertyName" : "type" }, "properties" : { "@type" : { "type" : "string" }, "bank_city" : { "type" : "string", "description" : "Bank city" }, "bank_name" : { "type" : "string", "description" : "Bank name" }, "bank_street" : { "type" : "string", "description" : "Bank street name" }, "bank_zip" : { "type" : "string", "description" : "Bank zip code" }, "owner" : { "type" : "string", "description" : "Name of the owner of the payment information" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aba" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank Account Number" }, "bic" : { "type" : "string", "description" : "Bank account BIC code (aka Swift Code)" }, "routing_number" : { "type" : "string", "description" : "Routing Number of the bank, (aka ABA code)" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Aubsb" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "auban" : { "type" : "string", "description" : "Bank account number" }, "aubsb" : { "type" : "string", "description" : "Bank state branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Brazilian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_code" : { "type" : "string", "description" : "Branch code" }, "pix_key" : { "type" : "string", "description" : "Pix key" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Canadian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "institution_number" : { "type" : "string", "description" : "Bank institution number" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" }, "transit_number" : { "type" : "string", "description" : "Bank transit number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Colombian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Guatemalan" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Hk" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Iban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bic" : { "type" : "string", "description" : "Bank account BIC code" }, "iban" : { "type" : "string", "description" : "Bank account IBAN" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Indian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "indian_financial_system_code" : { "type" : "string", "description" : "Indian financial system code" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Israeli" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_name" : { "type" : "string", "description" : "Branch name" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Japanese" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_code" : { "type" : "string", "description" : "Branch code" }, "branch_name" : { "type" : "string", "description" : "Branch name" }, "swift_code" : { "type" : "string", "description" : "Bank account swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Mexican" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "clabe" : { "type" : "string", "description" : "Clave Bancaria Estandarizada" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nuban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "nuban" : { "type" : "string", "description" : "The bank account NUBAN code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Nzbsb" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "nzban" : { "type" : "string", "description" : "Bank Account Number" }, "nzbsb" : { "type" : "string", "description" : "Bank State Branch code." } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Payout" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "bic" : { "type" : "string", "description" : "BIC" }, "iban" : { "type" : "string", "description" : "IBAN" }, "payout_format" : { "type" : "string", "description" : "Payout format" }, "sort_code" : { "type" : "string", "description" : "Sort code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Philippines" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Serbian" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Bank account number" }, "bank_branch_number" : { "type" : "string", "description" : "Bank branch number" }, "bic" : { "type" : "string", "description" : "Bank account BIC code" }, "iban" : { "type" : "string", "description" : "Bank account IBAN" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Sg" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "bank_key" : { "type" : "string", "description" : "Bank key" }, "swift_code" : { "type" : "string", "description" : "Swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Taiwanese" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_code" : { "type" : "string", "description" : "Bank code" }, "branch_code" : { "type" : "string", "description" : "Branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Thai" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uk" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "sort_code" : { "type" : "string", "description" : "Sort code" }, "swift_code" : { "type" : "string", "description" : "Swift code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Uruguayan" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "account_number" : { "type" : "string", "description" : "Account number" }, "bank_account_type" : { "type" : "string", "description" : "Account type\n
\n\n" }, "branch_code" : { "type" : "string", "description" : "Branch code" } } }, "IV01_Response_200_Invoices_AutoInvoice_PaymentInfo_Vietnamese" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_AutoInvoice_PaymentInfo" } ], "properties" : { "bank_account_number" : { "type" : "string", "description" : "Account number" }, "branch_name" : { "type" : "string", "description" : "Branch name" } } }, "IV01_Response_200_Invoices_AutoInvoice_Summary" : { "type" : "object", "properties" : { "amount_transferred" : { "type" : "number", "description" : "Total amount to be transferred to the seller" }, "amount_transferred_to_operator" : { "type" : "number", "description" : "Total amount to be transferred to the operator" }, "reserve_funding" : { "type" : "number", "description" : "Amount set aside for the seller reserve" }, "reserve_settlement" : { "type" : "number", "description" : "Amount paid out from the seller reserve" }, "total_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of commissions (excluding taxes on orders)" }, "total_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of commissions (including taxes on orders)" }, "total_fee_excl_tax" : { "type" : "number", "description" : "Total amount of fees (excluding taxes on orders)" }, "total_fee_incl_tax" : { "type" : "number", "description" : "Total amount of fees (including taxes on orders)" }, "total_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (excluding taxes on orders)" }, "total_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (including taxes on orders)" }, "total_mirakl_ads_credit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_credit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (including taxes on stores)" }, "total_mirakl_ads_debit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_debit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (including taxes on stores)" }, "total_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and taxes on orders)" }, "total_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (excluding taxes on orders)" }, "total_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (including taxes on orders)" }, "total_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount for order taxes remitted by the operator" }, "total_other_credits_excl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (excluding taxes on stores)" }, "total_other_credits_incl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (including taxes on stores)" }, "total_other_invoices_excl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (excluding taxes on stores)" }, "total_other_invoices_incl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (including taxes on stores)" }, "total_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for payable orders including shipping charges (excluding taxes on orders)" }, "total_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for payable orders including taxes (including taxes on orders)" }, "total_purchase_taxes" : { "type" : "number", "description" : "Total amount for purchase taxes" }, "total_refund_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (excluding taxes on orders)" }, "total_refund_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (including taxes on orders)" }, "total_refund_fee_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (excluding taxes on orders)" }, "total_refund_fee_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (including taxes on orders)" }, "total_refund_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (excluding taxes on orders)" }, "total_refund_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (including taxes on orders)" }, "total_refund_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_refund_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (excluding shipping charges and including taxes on orders)" }, "total_refund_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (excluding taxes on orders)" }, "total_refund_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (including taxes on orders)" }, "total_refund_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount of refunded taxes remitted by the operator" }, "total_refund_orders_excl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (excluding all refunded taxes)" }, "total_refund_orders_incl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (including all refunded taxes)" }, "total_refund_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (excluding taxes on orders)" }, "total_refund_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (including taxes on orders)" }, "total_refund_purchase_taxes" : { "type" : "number", "description" : "Total amount of refunded purchase taxes" }, "total_seller_fees_on_orders_excl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (excluding taxes on orders)" }, "total_seller_fees_on_orders_incl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (including taxes on orders)" }, "total_seller_penalty_fees_excl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (excluding taxes on orders)" }, "total_seller_penalty_fees_incl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (including taxes on orders)" }, "total_subscription_excl_tax" : { "type" : "number", "description" : "Total amount of subscription fees (excluding taxes on stores)" }, "total_subscription_incl_tax" : { "type" : "number", "description" : "Total amount of subscription taxes (including taxes on stores)" } } }, "IV01_Response_200_Invoices_Details" : { "type" : "object", "properties" : { "amount_excl_taxes" : { "type" : "number", "description" : "Amount excluding taxes" }, "description" : { "type" : "string", "description" : "Description" }, "operation_date" : { "type" : "string", "format" : "date-time", "description" : "Operation date for MANUAL_INVOICE or MANUAL_CREDIT type" }, "order_id" : { "type" : "string", "description" : "Associated order id. Only for MANUAL_INVOICE or MANUAL_CREDIT type" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity" }, "taxes" : { "type" : "array", "description" : "Taxes", "items" : { "$ref" : "#/components/schemas/IV01_Response_200_Invoices_Details_Taxes" } } } }, "IV01_Response_200_Invoices_Details_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "IV01_Response_200_Invoices_IssuingUser" : { "type" : "object", "properties" : { "information" : { "type" : "string", "description" : "User name if user type is OPERATOR or PARTNER, \"Automatic action\" if user type is BATCH" }, "type" : { "type" : "string", "description" : "User type (OPERATOR, BATCH or PARTNER)" } } }, "IV01_Response_200_Invoices_ManualCredit" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } ], "description" : "Manual accounting document", "properties" : { "seller_billing_cycle_id" : { "type" : "string", "description" : "The seller billing cycle identifier" } } }, "IV01_Response_200_Invoices_ManualInvoice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IV01_Response_200_Invoices" } ], "description" : "Manual accounting document", "properties" : { "seller_billing_cycle_id" : { "type" : "string", "description" : "The seller billing cycle identifier" } } }, "IV01_Response_200_Invoices_Payment" : { "type" : "object", "properties" : { "failure_reason" : { "type" : "string", "description" : "Failure reason" }, "reference" : { "type" : "string", "description" : "Transaction reference" }, "state" : { "type" : "string", "description" : "Payment status" }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Transaction date" } } }, "IV01_Response_200_Invoices_ShopAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "Shop contact address city" }, "civility" : { "type" : "string", "description" : "Shop contact civility" }, "country" : { "type" : "string", "description" : "Shop contact country (Formatted in ISO 3166-1). Used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country (see zip_code field)" }, "firstname" : { "type" : "string", "description" : "Shop contact first name" }, "lastname" : { "type" : "string", "description" : "Shop contact last name" }, "phone" : { "type" : "string", "description" : "Shop contact phone number" }, "phone_secondary" : { "type" : "string", "description" : "Shop contact secondary phone number" }, "state" : { "type" : "string", "description" : "Shop contact address state" }, "street1" : { "type" : "string", "description" : "Shop contact address first line" }, "street2" : { "type" : "string", "description" : "Shop contact address second line" }, "zip_code" : { "type" : "string", "description" : "Shop contact address zip code. Mandatory (unless the country_iso_code corresponds to Chile or Peru)" } } }, "IV01_Response_200_Invoices_TotalTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "L01_Response_200" : { "type" : "object", "properties" : { "locales" : { "type" : "array", "description" : "List of locales", "items" : { "$ref" : "#/components/schemas/L01_Response_200_Locales" } } } }, "L01_Response_200_Locales" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Locale code" }, "label" : { "type" : "string", "description" : "Locale label" }, "platform_default" : { "type" : "boolean", "description" : "Default locale of the platform" } } }, "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" } } }, "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" } } }, "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" } } }, "M10_Response_200_CustomerOrganization" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Customer organization name" }, "id" : { "type" : "string", "description" : "Customer organization id" } } }, "M10_Response_200_Entities" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Entity id" }, "label" : { "type" : "string", "description" : "Entity label" }, "type" : { "type" : "string", "description" : "Entity type" } } }, "M10_Response_200_Messages" : { "type" : "object", "properties" : { "attachments" : { "type" : "array", "description" : "Message attachments", "items" : { "$ref" : "#/components/schemas/M10_Response_200_Messages_Attachments" } }, "body" : { "type" : "string", "description" : "Message body" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Message creation date" }, "from" : { "$ref" : "#/components/schemas/M10_Response_200_Messages_From", "description" : "Message sender" }, "id" : { "type" : "string", "description" : "Message id" }, "to" : { "type" : "array", "description" : "Message recipients", "items" : { "$ref" : "#/components/schemas/M10_Response_200_Messages_To" } } } }, "M10_Response_200_Messages_Attachments" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Attachment id" }, "name" : { "type" : "string", "description" : "Attachment file name" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Attachment size" } } }, "M10_Response_200_Messages_From" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Sender display name" }, "organization_details" : { "$ref" : "#/components/schemas/M10_Response_200_Messages_From_OrganizationDetails", "description" : "Organization details of the sender" }, "type" : { "type" : "string", "description" : "Sender type" } } }, "M10_Response_200_Messages_From_OrganizationDetails" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Participant display name" }, "id" : { "type" : "string", "description" : "Participant id
When type equals OPERATOR, no id will be returned." }, "type" : { "type" : "string", "description" : "Participant type" } } }, "M10_Response_200_Messages_To" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Participant display name" }, "id" : { "type" : "string", "description" : "Participant id
When type equals OPERATOR, no id will be returned." }, "type" : { "type" : "string", "description" : "Participant type" } } }, "M10_Response_200_Metadata" : { "type" : "object", "properties" : { "last_message_date" : { "type" : "string", "format" : "date-time", "description" : "Date of the last message" }, "last_sender" : { "$ref" : "#/components/schemas/M10_Response_200_Metadata_LastSender", "description" : "Last message sender" }, "shop_reply_needed_since" : { "type" : "string", "format" : "date-time", "description" : "Date since the latest unanswered message awaiting a shop reply. Null when the shop has replied." }, "total_count" : { "type" : "integer", "format" : "int32", "description" : "Number of messages in the thread" } } }, "M10_Response_200_Metadata_LastSender" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Sender display name" }, "organization_details" : { "$ref" : "#/components/schemas/M10_Response_200_Metadata_LastSender_OrganizationDetails", "description" : "Organization details of the sender" }, "type" : { "type" : "string", "description" : "Sender type" } } }, "M10_Response_200_Metadata_LastSender_OrganizationDetails" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Participant display name" }, "id" : { "type" : "string", "description" : "Participant id
When type equals OPERATOR, no id will be returned." }, "type" : { "type" : "string", "description" : "Participant type" } } }, "M10_Response_200_NoStoreReplyNeeded" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date-time", "description" : "No store reply needed action date" }, "user_type" : { "type" : "string", "description" : "Entity that operated \"no store reply needed\" action.\n" } } }, "M10_Response_200_Topic" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Topic type" }, "value" : { "type" : "string", "description" : "Topic value" } } }, "M11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/M11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "M11_Response_200_Data" : { "type" : "object", "properties" : { "authorized_participants" : { "type" : "array", "description" : "Thread authorized 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" } } }, "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" } } }, "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" } } }, "M11_Response_200_Data_CustomerOrganization" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Customer organization name" }, "id" : { "type" : "string", "description" : "Customer organization id" } } }, "M11_Response_200_Data_Entities" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Entity id" }, "label" : { "type" : "string", "description" : "Entity label" }, "type" : { "type" : "string", "description" : "Entity type" } } }, "M11_Response_200_Data_Messages" : { "type" : "object", "properties" : { "attachments" : { "type" : "array", "description" : "Message attachments", "items" : { "$ref" : "#/components/schemas/M11_Response_200_Data_Messages_Attachments" } }, "body" : { "type" : "string", "description" : "Message body" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Message creation date" }, "from" : { "$ref" : "#/components/schemas/M11_Response_200_Data_Messages_From", "description" : "Message sender" }, "id" : { "type" : "string", "description" : "Message id" }, "to" : { "type" : "array", "description" : "Message recipients", "items" : { "$ref" : "#/components/schemas/M11_Response_200_Data_Messages_To" } } } }, "M11_Response_200_Data_Messages_Attachments" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Attachment id" }, "name" : { "type" : "string", "description" : "Attachment file name" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Attachment size" } } }, "M11_Response_200_Data_Messages_From" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Sender display name" }, "organization_details" : { "$ref" : "#/components/schemas/M11_Response_200_Data_Messages_From_OrganizationDetails", "description" : "Organization details of the sender" }, "type" : { "type" : "string", "description" : "Sender type" } } }, "M11_Response_200_Data_Messages_From_OrganizationDetails" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Participant display name" }, "id" : { "type" : "string", "description" : "Participant id
When type equals OPERATOR, no id will be returned." }, "type" : { "type" : "string", "description" : "Participant type" } } }, "M11_Response_200_Data_Messages_To" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Participant display name" }, "id" : { "type" : "string", "description" : "Participant id
When type equals OPERATOR, no id will be returned." }, "type" : { "type" : "string", "description" : "Participant type" } } }, "M11_Response_200_Data_Metadata" : { "type" : "object", "properties" : { "last_message_date" : { "type" : "string", "format" : "date-time", "description" : "Date of the last message" }, "last_sender" : { "$ref" : "#/components/schemas/M11_Response_200_Data_Metadata_LastSender", "description" : "Last message sender" }, "shop_reply_needed_since" : { "type" : "string", "format" : "date-time", "description" : "Date since the latest unanswered message awaiting a shop reply. Null when the shop has replied." }, "total_count" : { "type" : "integer", "format" : "int32", "description" : "Number of messages in the thread" } } }, "M11_Response_200_Data_Metadata_LastSender" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Sender display name" }, "organization_details" : { "$ref" : "#/components/schemas/M11_Response_200_Data_Metadata_LastSender_OrganizationDetails", "description" : "Organization details of the sender" }, "type" : { "type" : "string", "description" : "Sender type" } } }, "M11_Response_200_Data_Metadata_LastSender_OrganizationDetails" : { "type" : "object", "properties" : { "display_name" : { "type" : "string", "description" : "Participant display name" }, "id" : { "type" : "string", "description" : "Participant id
When type equals OPERATOR, no id will be returned." }, "type" : { "type" : "string", "description" : "Participant type" } } }, "M11_Response_200_Data_NoStoreReplyNeeded" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date-time", "description" : "No store reply needed action date" }, "user_type" : { "type" : "string", "description" : "Entity that operated \"no store reply needed\" action.\n" } } }, "M11_Response_200_Data_Topic" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Topic type" }, "value" : { "type" : "string", "description" : "Topic value" } } }, "OF01_Response_201" : { "type" : "object", "properties" : { "import_id" : { "type" : "integer", "format" : "int64", "description" : "Offer import identifier. If Mirakl detects a duplicate import request, the API will return the import_id of the existing import rather than creating a new one." }, "product_import_id" : { "type" : "integer", "format" : "int64", "description" : "Product import identifier" } } }, "OF02_Response_200" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Indicate if an error report exists" }, "import_id" : { "type" : "integer", "format" : "int64", "description" : "Import ID" }, "lines_in_error" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in error" }, "lines_in_pending" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in pending" }, "lines_in_success" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in success" }, "lines_read" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines read" }, "mode" : { "type" : "string", "description" : "Import mode" }, "offer_deleted" : { "type" : "integer", "format" : "int32", "description" : "Total count of deleted offers" }, "offer_inserted" : { "type" : "integer", "format" : "int32", "description" : "Total count of inserted offers" }, "offer_updated" : { "type" : "integer", "format" : "int32", "description" : "Total count of updated offers" }, "reason_status" : { "type" : "string", "description" : "Import status reason" }, "status" : { "type" : "string", "description" : "Import status" }, "type" : { "type" : "string", "deprecated" : true, "description" : "Will be remove in a future version" } } }, "OF04_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/OF04_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "OF04_Response_200_Data" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Indicate if an error report exists" }, "import_id" : { "type" : "integer", "format" : "int64", "description" : "Import ID" }, "lines_in_error" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in error" }, "lines_in_pending" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in pending" }, "lines_in_success" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in success" }, "lines_read" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines read" }, "mode" : { "type" : "string", "description" : "Import mode" }, "offer_deleted" : { "type" : "integer", "format" : "int32", "description" : "Total count of deleted offers" }, "offer_inserted" : { "type" : "integer", "format" : "int32", "description" : "Total count of inserted offers" }, "offer_updated" : { "type" : "integer", "format" : "int32", "description" : "Total count of updated offers" }, "origin" : { "type" : "string", "description" : "Import origin" }, "reason_status" : { "type" : "string", "description" : "Import status reason" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "status" : { "type" : "string", "description" : "Import status" } } }, "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" } }, "currency_iso_code" : { "type" : "string", "description" : "The currency of the shop (iso format)" }, "description" : { "type" : "string", "description" : "Offer description" }, "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" } }, "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" : "Minimum quantity of the offer" }, "min_shipping_price" : { "type" : "number", "description" : "Unit price of the minimum shipping rate" }, "min_shipping_price_additional" : { "type" : "number", "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" }, "model" : { "type" : "string", "description" : "Shop platform model, current possible values :\n" }, "msrp" : { "type" : "number", "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", "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_grade" : { "type" : "number", "description" : "Grade of the shop which proposes the offer" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Identifier of the shop which proposes the offer" }, "shop_name" : { "type" : "string", "description" : "Name of the shop which proposes the offer" }, "shop_sku" : { "type" : "string", "description" : "The offer's shop SKU" }, "state_code" : { "type" : "string", "description" : "Offer condition" }, "total_price" : { "type" : "number", "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" } } } }, "OF22_Response_200_AllPrices" : { "type" : "object", "properties" : { "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", "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", "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", "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" } } } }, "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", "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", "description" : "Unit discount price for this quantity threshold" }, "unit_origin_price" : { "type" : "number", "description" : "Unit price for this quantity threshold" } } }, "OF22_Response_200_ApplicablePricing" : { "type" : "object", "properties" : { "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", "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", "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", "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" } } } }, "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", "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", "description" : "Unit discount price for this quantity threshold" }, "unit_origin_price" : { "type" : "number", "description" : "Unit price for this quantity threshold" } } }, "OF22_Response_200_Discount" : { "type" : "object", "deprecated" : true, "properties" : { "discount_price" : { "type" : "number", "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", "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", "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" } } }, "OF22_Response_200_EcoContributions" : { "type" : "object", "properties" : { "eco_contribution_amount" : { "type" : "number", "description" : "Amount of the eco-contribution." }, "epr_category_code" : { "type" : "string", "description" : "Extended Producer Responsibility (EPR) category code.", "maxLength" : 255, "minLength" : 0 }, "producer_id" : { "type" : "string", "description" : "Producer identifier of the eco-contribution.", "maxLength" : 255, "minLength" : 0 } } }, "OF22_Response_200_Fulfillment" : { "type" : "object", "properties" : { "center" : { "$ref" : "#/components/schemas/OF22_Response_200_Fulfillment_Center", "description" : "Fulfillment center code" } } }, "OF22_Response_200_Fulfillment_Center" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Center code" } } }, "OF22_Response_200_LogisticClass" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Logistic class code" }, "label" : { "type" : "string", "description" : "Logistic class 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" } } }, "OF22_Response_200_OfferAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OF22_Response_200_OfferAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF22_Response_200_OfferAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF22_Response_200_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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" } } }, "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", "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", "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", "description" : "Original retail price for a quantity of one, i.e. the retail price for a quantity of one regardless of the discounts." } } }, "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" } } }, "OF24_Request" : { "type" : "object", "properties" : { "offers" : { "type" : "array", "description" : "Offers list", "items" : { "$ref" : "#/components/schemas/OF24_Request_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", "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", "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\"." } } }, "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", "description" : "The default unit discount price, i.e. the unit price when the discount applied." }, "unit_origin_price" : { "type" : "number", "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", "description" : "The unit discount price, i.e. the unit price when the discount applies" }, "unit_origin_price" : { "type" : "number", "description" : "The unit original price, i.e. the unit price excluding discounts" } } }, "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", "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", "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" } } }, "OF24_Request_Offers_EcoContributions" : { "type" : "object", "properties" : { "eco_contribution_amount" : { "type" : "number", "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." }, "producer_id" : { "type" : "string", "description" : "Producer identifier of the eco-contribution. Offer update: if not provided, existing data will be deleted." } } }, "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" } } }, "OF24_Request_Offers_OfferAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OF24_Request_Offers_OfferAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OF24_Request_Offers_OfferAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OF24_Request_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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", "description" : "The default unit discount retail price, i.e. the retail unit price when the discount applied." }, "unit_origin_price" : { "type" : "number", "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." } } }, "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" } }, "exclude_customer_specific_prices" : { "type" : "boolean", "description" : "Exclude customer prices from the export (specific prices for customer organizations or customer groups)." }, "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." }, "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 }, "models" : { "type" : "array", "description" : "List of platform models to filter with. Accepted values are MARKETPLACE, DROPSHIP, ONE_CREDITOR", "items" : { "type" : "string" } }, "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" } } }, "OF61_Response_200" : { "type" : "object", "properties" : { "offer_states" : { "type" : "array", "description" : "Offer conditions", "items" : { "$ref" : "#/components/schemas/OF61_Response_200_OfferStates" } } } }, "OF61_Response_200_OfferStates" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "description" : "Whether or not the offer state is active on the platform" }, "code" : { "type" : "string", "description" : "Offer condition code" }, "label" : { "type" : "string", "description" : "Offer condition label" } } }, "OR04_Request" : { "type" : "object", "properties" : { "orders" : { "type" : "array", "description" : "Orders to be updated, maximum number of orders per call: 100", "items" : { "$ref" : "#/components/schemas/OR04_Request_Orders" }, "maxItems" : 100, "minItems" : 1 } } }, "OR04_Request_Orders" : { "type" : "object", "description" : "Orders to be updated, maximum number of orders per call: 100", "properties" : { "customer" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer", "description" : "Customer information of the order (billing address)" }, "invoice_details" : { "$ref" : "#/components/schemas/OR04_Request_Orders_InvoiceDetails", "description" : "Invoice information linked to the order" }, "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" } }, "payment_destination" : { "$ref" : "#/components/schemas/OR04_Request_Orders_PaymentDestination", "description" : "Payment destination in case of bank transfer" }, "payment_workflow" : { "type" : "string", "description" : "Order payment workflow. Can only be updated from PAY_ON_DUE_DATE to PAY_ON_ACCEPTANCE" }, "references" : { "$ref" : "#/components/schemas/OR04_Request_Orders_References", "description" : "Order references" }, "shipping_deadline" : { "type" : "string", "format" : "date-time", "description" : "Latest date of order shipment" }, "shop_statistics" : { "$ref" : "#/components/schemas/OR04_Request_Orders_ShopStatistics", "description" : "Information about order exclusion from seller statistics" } } }, "OR04_Request_Orders_Customer" : { "type" : "object", "description" : "Customer information of the order (billing address)", "properties" : { "accounting_contact" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer_AccountingContact", "description" : "Data related to the accounting contact in the organization" }, "billing_address" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer_BillingAddress", "description" : "Customer billing address" }, "delivery_contact" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer_DeliveryContact", "description" : "Data related to the delivery contact in the organization" }, "organization" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer_Organization", "description" : "Data related to the organization that created the order (B2B transactions)" }, "shipping_address" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer_ShippingAddress", "description" : "Customer shipping address" } } }, "OR04_Request_Orders_Customer_AccountingContact" : { "type" : "object", "description" : "Data related to the delivery contact in the organization", "properties" : { "customer_id" : { "type" : "string", "description" : "Customer contact's identifier", "maxLength" : 50 } } }, "OR04_Request_Orders_Customer_BillingAddress" : { "type" : "object", "description" : "Customer billing address", "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, used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "OR04_Request_Orders_Customer_DeliveryContact" : { "type" : "object", "description" : "Data related to the delivery contact in the organization", "properties" : { "customer_id" : { "type" : "string", "description" : "Customer contact's identifier", "maxLength" : 50 } } }, "OR04_Request_Orders_Customer_Organization" : { "type" : "object", "description" : "Data related to the organization that created the order (B2B transactions)", "properties" : { "address" : { "$ref" : "#/components/schemas/OR04_Request_Orders_Customer_Organization_Address", "description" : "Address of the organization" }, "identification_number" : { "type" : "string", "description" : "Identification number of the organization", "maxLength" : 255 }, "name" : { "type" : "string", "description" : "Name of the organization", "maxLength" : 255 }, "tax_identification_number" : { "type" : "string", "description" : "Tax identification number of the organization", "maxLength" : 255 } } }, "OR04_Request_Orders_Customer_Organization_Address" : { "type" : "object", "description" : "Address of the organization", "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)" }, "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 } } }, "OR04_Request_Orders_Customer_ShippingAddress" : { "type" : "object", "description" : "Customer shipping address", "properties" : { "additional_info" : { "type" : "string", "description" : "Additional information for the shipping address", "maxLength" : 1000 }, "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, used by Mirakl to format the address (back office, delivery bill, invoices...) and to adapt the address validation to the country" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "internal_additional_info" : { "type" : "string", "description" : "Internal additional information for the shipping address", "maxLength" : 1000 }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "OR04_Request_Orders_InvoiceDetails" : { "type" : "object", "description" : "Invoice information linked to the order", "properties" : { "document_details" : { "type" : "array", "description" : "Invoice document information. Cannot be empty.", "items" : { "$ref" : "#/components/schemas/OR04_Request_Orders_InvoiceDetails_DocumentDetails" } }, "payment_terms" : { "$ref" : "#/components/schemas/OR04_Request_Orders_InvoiceDetails_PaymentTerms", "description" : "Payment terms" } } }, "OR04_Request_Orders_InvoiceDetails_DocumentDetails" : { "type" : "object", "properties" : { "format" : { "type" : "string", "description" : "Accounting document format" } } }, "OR04_Request_Orders_InvoiceDetails_PaymentTerms" : { "type" : "object", "description" : "Payment terms", "properties" : { "days" : { "type" : "integer", "format" : "int32", "description" : "Number of days" }, "type" : { "type" : "string", "description" : "Payment terms type.
Possible values: " } } }, "OR04_Request_Orders_OrderLines" : { "type" : "object", "description" : "Order lines to be updated", "properties" : { "eco_contributions" : { "type" : "array", "description" : "Eco-contributions to add or update on the order line - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "items" : { "$ref" : "#/components/schemas/OR04_Request_Orders_OrderLines_EcoContributions" } }, "order_line_id" : { "type" : "string", "description" : "Order line's identifier" } } }, "OR04_Request_Orders_OrderLines_EcoContributions" : { "type" : "object", "description" : "Eco-contributions to add or update on the order line - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.", "properties" : { "epr_category_code" : { "type" : "string", "description" : "Extended Producer Responsibility category" }, "producer_id" : { "type" : "string", "description" : "Producer identifier of the eco-contribution", "maxLength" : 255, "minLength" : 0 }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution", "maximum" : 100000000000000000, "minimum" : 0 } } }, "OR04_Request_Orders_PaymentDestination" : { "type" : "object", "description" : "Payment destination in case of bank transfer", "discriminator" : { "mapping" : { "IBAN" : "#/components/schemas/OR04_Request_Orders_PaymentDestination_Iban" }, "propertyName" : "@type" }, "properties" : { "@type" : { "type" : "string" }, "payment_reference" : { "type" : "string", "description" : "The payment reference for bank transfer" } } }, "OR04_Request_Orders_PaymentDestination_Iban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR04_Request_Orders_PaymentDestination" } ], "properties" : { "iban" : { "type" : "string", "description" : "Bank account IBAN", "maxLength" : 255, "minLength" : 0 } } }, "OR04_Request_Orders_References" : { "type" : "object", "description" : "Order references", "properties" : { "order_reference_for_customer" : { "type" : "string", "description" : "Order reference for customer, only operator and front can update this field. May not be blank.", "maxLength" : 2000, "minLength" : 1 }, "order_reference_for_seller" : { "type" : "string", "description" : "Order reference for seller. May not be blank.", "maxLength" : 2000, "minLength" : 1 } } }, "OR04_Request_Orders_ShopStatistics" : { "type" : "object", "description" : "Information about order exclusion from seller statistics", "properties" : { "excluded" : { "type" : "boolean", "description" : "Order exclusion from seller statistics. Indicate if true or false" }, "reason" : { "type" : "string", "description" : "Reason of order exclusion from seller statistics. Ignored if EXCLUDED is FALSE. Max length: 100 characters." } } }, "OR04_Response_200" : { "type" : "object", "properties" : { "updated_orders" : { "type" : "array", "description" : "A list of updated orders and orders in error objects", "items" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders" } } } }, "OR04_Response_200_UpdatedOrders" : { "type" : "object", "properties" : { "errors" : { "type" : "array", "description" : "List of errors encountered when updating order", "items" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Errors" } }, "order_id" : { "type" : "string", "description" : "Order identifier" }, "updated" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated", "description" : "Details of the modified order" } } }, "OR04_Response_200_UpdatedOrders_Errors" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Error code" }, "field" : { "type" : "string", "description" : "Name of the field on the input object. Can be composed, e.g.: address.zip_code" }, "message" : { "type" : "string", "description" : "Error message" } } }, "OR04_Response_200_UpdatedOrders_Updated" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer", "description" : "Customer information of the order (billing address, organization information)" }, "delivery_date" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_DeliveryDate", "description" : "Expected order delivery date" }, "invoice_details" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails", "description" : "Invoice information linked to the order" }, "leadtime_to_ship" : { "type" : "integer", "format" : "int32", "description" : "Lead time to ship of the order" }, "order_lines" : { "type" : "array", "description" : "Details of the modified order line", "items" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_OrderLines" } }, "payment_destination" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_PaymentDestination", "description" : "Payment destination in case of bank transfer" }, "payment_workflow" : { "type" : "string", "description" : "Order payment workflow" }, "references" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_References", "description" : "Order references" }, "shipping_deadline" : { "type" : "string", "format" : "date-time", "description" : "Latest date of order shipment" }, "shop_statistics" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_ShopStatistics", "description" : "Information about order exclusion from seller statistics" } } }, "OR04_Response_200_UpdatedOrders_Updated_Customer" : { "type" : "object", "properties" : { "accounting_contact" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer_AccountingContact", "description" : "Data related to the accounting contact in the organization" }, "billing_address" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer_BillingAddress", "description" : "Customer billing address" }, "delivery_contact" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer_DeliveryContact", "description" : "Data related to the delivery contact in the organization" }, "organization" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer_Organization", "description" : "Data related to the organization that created the order (B2B transactions)" }, "shipping_address" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer_ShippingAddress", "description" : "Customer shipping address" } } }, "OR04_Response_200_UpdatedOrders_Updated_Customer_AccountingContact" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "description" : "Customer contact's identifier", "maxLength" : 50 } } }, "OR04_Response_200_UpdatedOrders_Updated_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" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "OR04_Response_200_UpdatedOrders_Updated_Customer_DeliveryContact" : { "type" : "object", "properties" : { "customer_id" : { "type" : "string", "description" : "Customer contact's identifier", "maxLength" : 50 } } }, "OR04_Response_200_UpdatedOrders_Updated_Customer_Organization" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_Customer_Organization_Address", "description" : "Address of the organization" }, "identification_number" : { "type" : "string", "description" : "Identification number of the organization", "maxLength" : 255 }, "name" : { "type" : "string", "description" : "Name of the organization", "maxLength" : 255 }, "tax_identification_number" : { "type" : "string", "description" : "Tax identification number of the organization", "maxLength" : 255 } } }, "OR04_Response_200_UpdatedOrders_Updated_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" }, "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", "maxLength" : 255 } } }, "OR04_Response_200_UpdatedOrders_Updated_Customer_ShippingAddress" : { "type" : "object", "properties" : { "additional_info" : { "type" : "string", "description" : "Additional information for the shipping address" }, "city" : { "type" : "string", "description" : "Address city" }, "civility" : { "type" : "string", "description" : "Civility of the person associated with the address" }, "company" : { "type" : "string", "description" : "Company of the person associated with the address" }, "company_2" : { "type" : "string", "description" : "Second company information of the person associated with the address" }, "country" : { "type" : "string", "description" : "Address country" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO 3166-1 code of the address" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "internal_additional_info" : { "type" : "string", "description" : "Internal additional information for the shipping address" }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "OR04_Response_200_UpdatedOrders_Updated_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" } } }, "OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails" : { "type" : "object", "properties" : { "document_details" : { "type" : "array", "description" : "Invoice document information", "items" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails_DocumentDetails" } }, "payment_terms" : { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails_PaymentTerms", "description" : "Payment terms" } } }, "OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails_DocumentDetails" : { "type" : "object", "properties" : { "format" : { "type" : "string", "description" : "Accounting document format" } } }, "OR04_Response_200_UpdatedOrders_Updated_InvoiceDetails_PaymentTerms" : { "type" : "object", "properties" : { "days" : { "type" : "integer", "format" : "int32", "description" : "Number of days" }, "type" : { "type" : "string", "description" : "Payment terms type.
Possible values: " } } }, "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR04_Response_200_UpdatedOrders_Updated_PaymentDestination" : { "type" : "object", "discriminator" : { "mapping" : { "IBAN" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_PaymentDestination_Iban" }, "propertyName" : "@type" }, "properties" : { "@type" : { "type" : "string" }, "payment_reference" : { "type" : "string", "description" : "The payment reference for bank transfer" } } }, "OR04_Response_200_UpdatedOrders_Updated_PaymentDestination_Iban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR04_Response_200_UpdatedOrders_Updated_PaymentDestination" } ], "properties" : { "iban" : { "type" : "string", "description" : "Bank account IBAN", "maxLength" : 255, "minLength" : 0 } } }, "OR04_Response_200_UpdatedOrders_Updated_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" } } }, "OR04_Response_200_UpdatedOrders_Updated_ShopStatistics" : { "type" : "object", "properties" : { "excluded" : { "type" : "boolean", "description" : "Order exclusion from seller statistics. Indicate if true or false" }, "reason" : { "type" : "string", "description" : "Reason of order exclusion from shop statistics. Ignored if EXCLUDED is FALSE. Max length: 100 characters." } } }, "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 } } }, "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" } } }, "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" } } }, "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" } } }, "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" } } }, "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" } } }, "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" } } }, "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_evaluate" : { "type" : "boolean", "description" : "Indicates if the order can be evaluated by the customer" }, "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" }, "commissionable" : { "type" : "boolean", "description" : "Indicates if the order is commissionable. Only available when the platform follows a mixed commission model" }, "created_date" : { "type" : "string", "format" : "date-time", "description" : "Order's creation date" }, "currency_iso_code" : { "type" : "string", "description" : "Shop's currency (iso format)" }, "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." }, "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." }, "imprint_number" : { "type" : "string", "description" : "The payment's imprint number given in OR01 input" }, "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" }, "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" }, "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: " }, "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" } }, "pay_out_psp_code" : { "type" : "string", "description" : "PSP code for Pay-out" }, "payment_destination" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_PaymentDestination", "description" : "Payment destination in case of bank transfer" }, "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" }, "price" : { "type" : "number", "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", "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" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop's identifier" }, "shop_name" : { "type" : "string", "description" : "Shop's name" }, "total_commission" : { "type" : "number", "description" : "Order's total commission (sum of the order line's total commission)" }, "total_price" : { "type" : "number", "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" }, "waiting_funding_confirmation" : { "type" : "boolean", "description" : "True if the order is awaiting a funding update (dependent on 'Pause the order debit workflow when funding must be updated' operator toggle activation). False otherwise." }, "waiting_tax_confirmation" : { "type" : "boolean", "description" : "True if the order is awaiting a tax confirmation (dependent on 'Pause the order debit workflow when taxes must be recalculated' operator toggle activation). False otherwise." } } }, "OR11_Response_200_Orders_Channel" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Channel code" }, "label" : { "type" : "string", "description" : "Channel 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" }, "billing_address" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_Customer_BillingAddress", "description" : "Customer's billing address" }, "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" }, "email" : { "type" : "string", "description" : "Customer's email" }, "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" } } }, "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 }, "email" : { "type" : "string", "description" : "Customer contact's email", "maxLength" : 255 }, "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" } } }, "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" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "OR11_Response_200_Orders_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 }, "email" : { "type" : "string", "description" : "Customer contact's email", "maxLength" : 255 }, "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" } } }, "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." }, "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.", "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)", "maxLength" : 50 }, "tax_identification_number" : { "type" : "string", "description" : "Tax identification number of the organization.", "maxLength" : 255 } } }, "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)" }, "state" : { "type" : "string", "description" : "Address state", "maxLength" : 255 }, "street_1" : { "type" : "string", "description" : "First information line of the address street", "maxLength" : 255 }, "street_2" : { "type" : "string", "description" : "Second information line of the address street", "maxLength" : 255 }, "zip_code" : { "type" : "string", "description" : "Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay", "maxLength" : 255 } } }, "OR11_Response_200_Orders_Customer_ShippingAddress" : { "type" : "object", "properties" : { "additional_info" : { "type" : "string", "description" : "Additional information for the shipping address" }, "city" : { "type" : "string", "description" : "Address city" }, "civility" : { "type" : "string", "description" : "Civility of the person associated with the address" }, "company" : { "type" : "string", "description" : "Company of the person associated with the address" }, "company_2" : { "type" : "string", "description" : "Second company information of the person associated with the address" }, "country" : { "type" : "string", "description" : "Address country" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO 3166-1 code of the address" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "internal_additional_info" : { "type" : "string", "description" : "Internal additional information for the shipping address" }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "OR11_Response_200_Orders_DeliveryDate" : { "type" : "object", "properties" : { "earliest" : { "type" : "string", "format" : "date-time", "description" : "Earliest order delivery date" }, "latest" : { "type" : "string", "format" : "date-time", "description" : "Latest order delivery date" } } }, "OR11_Response_200_Orders_DiscountCampaigns" : { "type" : "object", "properties" : { "identifier" : { "type" : "string", "description" : "The unique identifier of the discount campaign" } } }, "OR11_Response_200_Orders_Fulfillment" : { "type" : "object", "properties" : { "center" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_Fulfillment_Center", "description" : "Fulfillment center code" } } }, "OR11_Response_200_Orders_Fulfillment_Center" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Center code" } } }, "OR11_Response_200_Orders_InvoiceDetails" : { "type" : "object", "properties" : { "document_details" : { "type" : "array", "description" : "Invoice document information", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_InvoiceDetails_DocumentDetails" } }, "payment_terms" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_InvoiceDetails_PaymentTerms", "description" : "Payment terms" } } }, "OR11_Response_200_Orders_InvoiceDetails_DocumentDetails" : { "type" : "object", "properties" : { "format" : { "type" : "string", "description" : "Accounting document format" } } }, "OR11_Response_200_Orders_InvoiceDetails_PaymentTerms" : { "type" : "object", "properties" : { "days" : { "type" : "integer", "format" : "int32", "description" : "Number of days" }, "type" : { "type" : "string", "description" : "Payment terms type.
Possible values: " } } }, "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" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR11_Response_200_Orders_OrderAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines" : { "type" : "object", "properties" : { "can_open_incident" : { "type" : "boolean", "description" : "Indicate if an incident can be opened on the order line" }, "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", "description" : "Order line's commission fee" }, "commission_taxes" : { "type" : "array", "description" : "Commission taxes", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_CommissionTaxes" } }, "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" } }, "funding" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding", "description" : "The funding details of the order line" }, "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" }, "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", "description" : "The original unit price of the offer associated with the order line" }, "price" : { "type" : "number", "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", "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", "description" : "Total price of the order line's shipping price" }, "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_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" }, "tax_recalculation_required" : { "type" : "boolean", "description" : "True if the taxes of the order line must be recalculated. False otherwise" }, "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", "description" : "Order line's total commission (sum of the commission fee and the commission vat)" }, "total_price" : { "type" : "number", "description" : "Order line's price with shipping price and fees." } } }, "OR11_Response_200_Orders_OrderLines_Cancelations" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "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", "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" } }, "funding" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding", "description" : "The funding details of the cancelation" }, "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", "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" } } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_CommissionTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax 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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Fees" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Fee amount" }, "code" : { "type" : "string", "description" : "Fee code" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer", "description" : "The customer funding canceled" }, "operator" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator", "description" : "The operator funding canceled" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer" : { "type" : "object", "properties" : { "fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Fees", "description" : "The customer funding applying on fees" }, "offer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Offer", "description" : "The customer funding applying on the order line offer" }, "shipping" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Shipping", "description" : "The customer funding applying on the shipping" }, "total_amount" : { "type" : "number", "description" : "The total amount of the customer funding" }, "total_tax_amount" : { "type" : "number", "description" : "The total amount of taxes of the customer funding" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Fees" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on fees", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Fees_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Fees_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Offer" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on the order line offer", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Offer_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Offer_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Shipping" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on the shipping", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Shipping_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Customer_Shipping_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator" : { "type" : "object", "properties" : { "fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Fees", "description" : "The operator funding applying on fees" }, "offer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Offer", "description" : "The operator funding applying on the order line offer" }, "shipping" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Shipping", "description" : "The operator funding applying on the shipping" }, "total_amount" : { "type" : "number", "description" : "The total amount of the operator funding" }, "total_tax_amount" : { "type" : "number", "description" : "The total amount of taxes of the operator funding" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Fees" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on fees", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Fees_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Fees_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Offer" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on the order line offer", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Offer_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Offer_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Shipping" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on the shipping", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Shipping_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Funding_Operator_Shipping_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "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", "description" : "Cancelation’s purchase commission amount" }, "purchase_commission_on_shipping" : { "type" : "number", "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", "description" : "Cancelation’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price" : { "type" : "number", "description" : "Cancelation’s purchase shipping charges" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseCommissionOnFees" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Cancelation’s purchase commission total amount on fees" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_PurchaseInformation_PurchaseFeeAmount" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Cancelation’s purchase fee 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 } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingAmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_ShippingTaxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Cancelations_Taxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "OR11_Response_200_Orders_OrderLines_CommissionTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" }, "rate" : { "type" : "number", "description" : "Tax rate, as a percentage (between 0 and 100)" } } }, "OR11_Response_200_Orders_OrderLines_DiscountCampaign" : { "type" : "object", "properties" : { "identifier" : { "type" : "string", "description" : "The unique identifier of the discount campaign" } } }, "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR11_Response_200_Orders_OrderLines_Fees" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Fee amount" }, "code" : { "type" : "string", "description" : "Fee code" } } }, "OR11_Response_200_Orders_OrderLines_Funding" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer", "description" : "The customer funding applying on the order line" }, "operator" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator", "description" : "The operator funding applying on the order line" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer" : { "type" : "object", "properties" : { "fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer_Fees", "description" : "The customer funding applying on fees" }, "offer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer_Offer", "description" : "The customer funding applying on the order line offer" }, "shipping" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer_Shipping", "description" : "The customer funding applying on the shipping" }, "total_amount" : { "type" : "number", "description" : "The total amount of the customer funding" }, "total_tax_amount" : { "type" : "number", "description" : "The total amount of taxes of the customer funding" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer_Fees" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on fees", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer_Fees_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer_Fees_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer_Offer" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on the order line offer", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer_Offer_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer_Offer_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer_Shipping" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on the shipping", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Customer_Shipping_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Funding_Customer_Shipping_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator" : { "type" : "object", "properties" : { "fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator_Fees", "description" : "The operator funding applying on fees" }, "offer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator_Offer", "description" : "The operator funding applying on the order line offer" }, "shipping" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator_Shipping", "description" : "The operator funding applying on the shipping" }, "total_amount" : { "type" : "number", "description" : "The total amount of the operator funding" }, "total_tax_amount" : { "type" : "number", "description" : "The total amount of taxes of the operator funding" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator_Fees" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on fees", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator_Fees_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator_Fees_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator_Offer" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on the order line offer", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator_Offer_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator_Offer_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator_Shipping" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on the shipping", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Funding_Operator_Shipping_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Funding_Operator_Shipping_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Measurement" : { "type" : "object", "properties" : { "actual_measurement" : { "type" : "number", "description" : "Actual measurement on the order line" }, "adjustment_limit" : { "type" : "number", "description" : "Adjustment limit of the order line" }, "measurement_unit" : { "type" : "string", "description" : "Measurement unit of the order line" }, "ordered_measurement" : { "type" : "number", "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" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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 } } }, "OR11_Response_200_Orders_OrderLines_PriceAmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "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...)" } } }, "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", "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" } } }, "OR11_Response_200_Orders_OrderLines_Promotions_Campaign" : { "type" : "object", "properties" : { "identifier" : { "type" : "string", "description" : "The identifier of the promotion campaign." } } }, "OR11_Response_200_Orders_OrderLines_Promotions_Configuration" : { "type" : "object", "properties" : { "amount_off" : { "type" : "number", "description" : "The amount off of the promotion.
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", "description" : "The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise." }, "reduced_unit_price" : { "type" : "number", "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)" } } }, "OR11_Response_200_Orders_OrderLines_PurchaseInformation" : { "type" : "object", "properties" : { "purchase_commission_on_fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees", "description" : "Purchase order line’s commission on fees" }, "purchase_commission_on_price" : { "type" : "number", "description" : "Purchase order line’s commission amount" }, "purchase_commission_on_shipping" : { "type" : "number", "description" : "Purchase order line’s commission amount on shipping" }, "purchase_fee_amount" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount", "description" : "Purchase order line’s fees" }, "purchase_price" : { "type" : "number", "description" : "Purchase order line’s price excluding shipping charges and fees" }, "purchase_shipping_price" : { "type" : "number", "description" : "Purchase order line’s shipping charges" }, "purchase_unit_price" : { "type" : "number", "description" : "Purchase unit price computed from the given offer price" } } }, "OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseCommissionOnFees" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Purchase order line’s commission total amount on fees" } } }, "OR11_Response_200_Orders_OrderLines_PurchaseInformation_PurchaseFeeAmount" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Purchase order line’s fee total amount" } } }, "OR11_Response_200_Orders_OrderLines_Refunds" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Refund's amount" }, "amount_breakdown" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown", "description" : "The breakdown of the refund's amount, only available when advanced features are enabled" }, "commission_amount" : { "type" : "number", "description" : "Refund's commission amount" }, "commission_taxes" : { "type" : "array", "description" : "Refund's commission taxes", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_CommissionTaxes" } }, "commission_total_amount" : { "type" : "number", "description" : "The total commission amount of the refund (commission amount + commission taxes)" }, "created_date" : { "type" : "string", "format" : "date-time", "description" : "Refund's creation date" }, "eco_contributions" : { "type" : "array", "description" : "List of eco-contribution amounts and corresponding producer identifiers, if 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" } }, "funding" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding", "description" : "The funding details of the refund" }, "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" }, "shipping_amount" : { "type" : "number", "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" }, "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" } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Refunds_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Refunds_CommissionTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax 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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Fees" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Fee amount" }, "code" : { "type" : "string", "description" : "Fee code" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding" : { "type" : "object", "properties" : { "customer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer", "description" : "The customer funding refunded" }, "operator" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator", "description" : "The operator funding refunded" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer" : { "type" : "object", "properties" : { "fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Fees", "description" : "The customer funding applying on fees" }, "offer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Offer", "description" : "The customer funding applying on the order line offer" }, "shipping" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Shipping", "description" : "The customer funding applying on the shipping" }, "total_amount" : { "type" : "number", "description" : "The total amount of the customer funding" }, "total_tax_amount" : { "type" : "number", "description" : "The total amount of taxes of the customer funding" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Fees" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on fees", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Fees_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Fees_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Offer" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on the order line offer", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Offer_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Offer_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Shipping" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the customer funding applying on the shipping", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Shipping_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Customer_Shipping_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator" : { "type" : "object", "properties" : { "fees" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Fees", "description" : "The operator funding applying on fees" }, "offer" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Offer", "description" : "The operator funding applying on the order line offer" }, "shipping" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Shipping", "description" : "The operator funding applying on the shipping" }, "total_amount" : { "type" : "number", "description" : "The total amount of the operator funding" }, "total_tax_amount" : { "type" : "number", "description" : "The total amount of taxes of the operator funding" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Fees" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on fees", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Fees_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Fees_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Offer" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on the order line offer", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Offer_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Offer_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Shipping" : { "type" : "object", "properties" : { "breakdown" : { "type" : "array", "description" : "The details of the operator funding applying on the shipping", "items" : { "$ref" : "#/components/schemas/OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Shipping_Breakdown" } } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Funding_Operator_Shipping_Breakdown" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The amount funded by the payment method" }, "method" : { "type" : "string", "description" : "The payment method" } } }, "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", "description" : "Refund’s purchase commission amount" }, "purchase_commission_on_shipping" : { "type" : "number", "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", "description" : "Refund’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price" : { "type" : "number", "description" : "Refund’s purchase shipping charges" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseCommissionOnFees" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Refund’s purchase commission total amount on fees" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_PurchaseInformation_PurchaseFeeAmount" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Refund’s purchase fee 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 } } }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingAmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Refunds_ShippingTaxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Refunds_Taxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "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" } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_ShippingPriceAmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "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." } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_ShippingTaxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "OR11_Response_200_Orders_OrderLines_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "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", "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." } } }, "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 } } }, "OR11_Response_200_Orders_OrderLines_Taxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR11_Response_200_Orders_OrderLines_Taxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "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" } } } }, "OR11_Response_200_Orders_OrderRefunds_Taxes" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Order tax code" }, "rate" : { "type" : "number", "description" : "Order tax rate" }, "total_amount" : { "type" : "number", "description" : "Order total refunded tax amount for product and shipping, for a defined tax code and rate" } } }, "OR11_Response_200_Orders_OrderTaxes" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Order tax code" }, "rate" : { "type" : "number", "description" : "Order tax rate" }, "total_amount" : { "type" : "number", "description" : "Order total tax amount for product and shipping, for a defined tax code and rate" } } }, "OR11_Response_200_Orders_PaymentDestination" : { "type" : "object", "discriminator" : { "mapping" : { "IBAN" : "#/components/schemas/OR11_Response_200_Orders_PaymentDestination_Iban" }, "propertyName" : "@type" }, "properties" : { "@type" : { "type" : "string" }, "payment_reference" : { "type" : "string", "description" : "The payment reference for bank transfer" } } }, "OR11_Response_200_Orders_PaymentDestination_Iban" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR11_Response_200_Orders_PaymentDestination" } ], "properties" : { "iban" : { "type" : "string", "description" : "Bank account IBAN", "maxLength" : 255, "minLength" : 0 } } }, "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", "description" : "The total amount deduced on this order thanks to the promotions" } } }, "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", "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" } } }, "OR11_Response_200_Orders_Promotions_AppliedPromotions_Campaign" : { "type" : "object", "properties" : { "identifier" : { "type" : "string", "description" : "The identifier of the promotion campaign." } } }, "OR11_Response_200_Orders_Promotions_AppliedPromotions_Configuration" : { "type" : "object", "properties" : { "amount_off" : { "type" : "number", "description" : "The amount off of the promotion.
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", "description" : "The percentage off of the promotion.
Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise." }, "reduced_unit_price" : { "type" : "number", "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)" } } }, "OR11_Response_200_Orders_References" : { "type" : "object", "properties" : { "order_reference_for_customer" : { "type" : "string", "description" : "Order reference for customer" }, "order_reference_for_seller" : { "type" : "string", "description" : "Order reference for seller" } } }, "OR13_Request" : { "type" : "object", "properties" : { "channel_codes" : { "type" : "array", "description" : "A list of channel codes", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "end_date" : { "type" : "string", "format" : "date-time", "description" : "End order creation date for filtering. Must be used with start_date." }, "end_refund_creation_date" : { "type" : "string", "format" : "date-time", "description" : "End refund creation date to filter on orders with at least one refund created before this date. Must be used with start_refund_creation_date, and cannot be later than a month after start_refund_creation_date." }, "end_update_date" : { "type" : "string", "format" : "date-time", "description" : "End order update date for filtering. Must be used with start_update_date." }, "fulfillment_center_codes" : { "type" : "string", "description" : "Code of the fulfillment center", "maxLength" : 100, "minLength" : 0 }, "items_per_chunk" : { "type" : "integer", "format" : "int64", "default" : 1000000, "description" : "Maximum number of items included in the generated files", "maximum" : 1000000, "minimum" : 10000 }, "megabytes_per_chunk" : { "type" : "integer", "format" : "int64", "default" : 512, "description" : "Maximum mega bytes weight for generated files", "maximum" : 1024, "minimum" : 10 }, "only_null_channel" : { "type" : "boolean", "default" : false, "description" : "Return only orders without channel. If true, ignore the channel_codes" }, "order_state_codes" : { "type" : "array", "description" : "A list of order state's codes", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "order_tax_mode" : { "type" : "string", "description" : "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
Possible values:
  • If this query parameter is not specified, the default order tax mode of the platform is used.
    • " }, "refund_state_codes" : { "type" : "array", "description" : "Filter on the refund state\nTo be used in combination with filters start_update_date and end_update_date, with a maximum of one month period.\n", "items" : { "type" : "string" } }, "shop_ids" : { "type" : "array", "description" : "A list of shop's identifiers", "items" : { "type" : "integer", "format" : "int64" }, "maxItems" : 100, "minItems" : 0 }, "start_date" : { "type" : "string", "format" : "date-time", "description" : "Start order creation date for filtering. Must be used with end_date." }, "start_refund_creation_date" : { "type" : "string", "format" : "date-time", "description" : "Start refund creation date to filter on orders with at least one refund created after this date. Must be used with end_refund_creation_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." }, "tax_recalculation_required_only" : { "type" : "boolean", "description" : "If true returns only orders for which taxes must be recalculated on at least one order line. When false it does not impact the result. Must be used with at least one date range filter: created or last updated date, of a maximum duration of one month." }, "waiting_funding_confirmation" : { "type" : "boolean", "description" : "If true returns only orders awaiting a funding update. When false it does not impact the result." }, "waiting_tax_confirmation" : { "type" : "boolean", "description" : "If true returns only orders awaiting a tax confirmation, When false it does not impact the result." } } }, "OR13_Response_200" : { "type" : "object", "properties" : { "tracking_id" : { "type" : "string", "description" : "Id to poll in order to track the export's progress" } } }, "OR14_Response_200" : { "type" : "object", "properties" : { "last_updated" : { "type" : "string", "format" : "date-time", "description" : "The last updated date of the export" }, "status" : { "type" : "string", "description" : "Current status of the export, can be 'PENDING', 'FAILED', or 'COMPLETED'" }, "urls" : { "type" : "array", "description" : "List of generated URLs to call to download each generated chunks", "items" : { "type" : "string" } } } }, "OR21_Request" : { "type" : "object", "properties" : { "order_lines" : { "type" : "array", "description" : "List of representations of order line for acceptance", "items" : { "$ref" : "#/components/schemas/OR21_Request_OrderLines" } } } }, "OR21_Request_OrderLines" : { "type" : "object", "description" : "List of representations of order line for acceptance", "properties" : { "accepted" : { "type" : "boolean", "description" : "Boolean indicating if the order line is accepted or refused" }, "id" : { "type" : "string", "description" : "Order line's identifier" } } }, "OR23_Request" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "The code of a carrier. This information is mandatory for a registered carrier." }, "carrier_name" : { "type" : "string", "description" : "The name of a carrier. This information is mandatory for an unregistered carrier." }, "carrier_standard_code" : { "type" : "string", "description" : "Carrier standard code" }, "carrier_url" : { "type" : "string", "description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers." }, "tracking_number" : { "type" : "string", "description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number." } } }, "OR28_Request" : { "type" : "object", "properties" : { "order_tax_mode" : { "type" : "string", "description" : "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
    Possible values:" }, "refunds" : { "type" : "array", "description" : "List of representations of refunds to be created", "items" : { "$ref" : "#/components/schemas/OR28_Request_Refunds" } } } }, "OR28_Request_Refunds" : { "type" : "object", "description" : "List of representations of refunds to be created", "properties" : { "amount" : { "type" : "number", "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)" }, "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", "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" } }, "tax_legal_notice" : { "type" : "string", "description" : "The legal notice applying to the refund’s tax calculation" }, "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" } } } }, "OR28_Request_Refunds_Fees" : { "type" : "object", "description" : "The fee part amount to be refunded", "properties" : { "amount" : { "type" : "number", "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", "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", "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: " }, "refunds" : { "type" : "array", "description" : "List of representations of created refunds", "items" : { "$ref" : "#/components/schemas/OR28_Response_200_Refunds" } } } }, "OR28_Response_200_Refunds" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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)" }, "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", "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" } }, "tax_legal_notice" : { "type" : "string", "description" : "The legal notice applying to the refund taxes" }, "taxes" : { "type" : "array", "description" : "List of taxes refunded on product price", "items" : { "$ref" : "#/components/schemas/OR28_Response_200_Refunds_Taxes" } } } }, "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 } } }, "OR28_Response_200_Refunds_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR28_Response_200_Refunds_Fees" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Refund’s purchase commission amount" }, "purchase_commission_on_shipping" : { "type" : "number", "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", "description" : "Refund’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price" : { "type" : "number", "description" : "Refund’s purchase shipping charges" } } }, "OR28_Response_200_Refunds_PurchaseInformation_PurchaseCommissionOnFees" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Refund’s purchase commission total amount on fees" } } }, "OR28_Response_200_Refunds_PurchaseInformation_PurchaseFeeAmount" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Refund’s purchase fee 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 } } }, "OR28_Response_200_Refunds_ShippingAmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR28_Response_200_Refunds_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR28_Response_200_Refunds_ShippingTaxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR28_Response_200_Refunds_ShippingTaxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "OR28_Response_200_Refunds_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR28_Response_200_Refunds_Taxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR28_Response_200_Refunds_Taxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "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" } } }, "OR30_Request_Cancelations" : { "type" : "object", "description" : "List of representations of cancellations to be created", "properties" : { "amount" : { "type" : "number", "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)" }, "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", "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" } } } }, "OR30_Request_Cancelations_Fees" : { "type" : "object", "description" : "The fees to be canceled", "properties" : { "amount" : { "type" : "number", "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", "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", "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: " } } }, "OR30_Response_200_Cancelations" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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)" }, "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", "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" } } } }, "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 } } }, "OR30_Response_200_Cancelations_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR30_Response_200_Cancelations_Fees" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Cancelation’s purchase commission amount" }, "purchase_commission_on_shipping" : { "type" : "number", "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", "description" : "Cancelation’s purchase price excluding shipping charges and fees" }, "purchase_shipping_price" : { "type" : "number", "description" : "Cancelation’s purchase shipping charges" } } }, "OR30_Response_200_Cancelations_PurchaseInformation_PurchaseCommissionOnFees" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Cancelation’s purchase commission total amount on fees" } } }, "OR30_Response_200_Cancelations_PurchaseInformation_PurchaseFeeAmount" : { "type" : "object", "properties" : { "total_amount" : { "type" : "number", "description" : "Cancelation’s purchase fee 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 } } }, "OR30_Response_200_Cancelations_ShippingAmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR30_Response_200_Cancelations_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR30_Response_200_Cancelations_ShippingTaxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR30_Response_200_Cancelations_ShippingTaxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "OR30_Response_200_Cancelations_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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", "description" : "Tax rate" } } }, "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 } } }, "OR30_Response_200_Cancelations_Taxes_AmountBreakdown_Parts" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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." } } }, "OR30_Response_200_Cancelations_Taxes_PurchaseTax" : { "type" : "object", "properties" : { "purchase_amount" : { "type" : "number", "description" : "Purchase tax amount" }, "purchase_rate" : { "type" : "number", "description" : "Purchase tax rate" } } }, "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" } } }, "OR31_Request_OrderAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR31_Request_OrderAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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" } } }, "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" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Request_OrderLines_OrderLineAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Request_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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" } }, "input" : { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input", "description" : "Invalid order custom fields values received" } } }, "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" } } }, "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" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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" } } }, "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" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateErrors_Input_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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" } } }, "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" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/OR31_Response_200_OrderUpdateResult_OrderLines_OrderLineAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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 } } }, "OR32_Request_OrderLines" : { "type" : "object", "description" : "Order lines to be updated, maximum number of order lines per call: 100", "properties" : { "actual_measurement" : { "type" : "number", "description" : "Order line's actual measurement" }, "order_line_id" : { "type" : "string", "description" : "Order Line identifier" } } }, "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", "description" : "The offer part amount canceled" }, "currency_iso_code" : { "type" : "string" }, "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", "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR32_Response_200_OrderLinesAdjusted_Cancelations_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "OR32_Response_200_OrderLinesAdjusted_Cancelations_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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" } } }, "OR32_Response_200_OrderLinesAdjusted_Measurement" : { "type" : "object", "properties" : { "actual_measurement" : { "type" : "number", "description" : "Actual measurement on the order line" }, "adjustment_limit" : { "type" : "number", "description" : "Adjustment limit of the order line" }, "measurement_unit" : { "type" : "string", "description" : "Measurement unit of the order line" }, "ordered_measurement" : { "type" : "number", "description" : "Total measurement ordered on the order line" } } }, "OR32_Response_200_OrderLinesAdjusted_Refunds" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "The offer part amount refunded." }, "currency_iso_code" : { "type" : "string" }, "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", "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." }, "producer_id_owner" : { "type" : "string", "description" : "Owner of the producerId" }, "total_amount" : { "type" : "number", "description" : "Total amount of the eco-contribution" }, "unit_amount" : { "type" : "number", "description" : "Unit amount of the eco-contribution" } } }, "OR32_Response_200_OrderLinesAdjusted_Refunds_ShippingTaxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Tax amount" }, "code" : { "type" : "string", "description" : "Tax code" } } }, "OR32_Response_200_OrderLinesAdjusted_Refunds_Taxes" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "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 } } }, "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" } } }, "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" } } }, "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" } } }, "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" } } }, "OR72_Response_200" : { "type" : "object", "properties" : { "order_documents" : { "type" : "array", "description" : "The document details", "items" : { "$ref" : "#/components/schemas/OR72_Response_200_OrderDocuments" } } } }, "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" } } }, "OR75_Response_200" : { "type" : "object", "properties" : { "taxes" : { "type" : "array", "description" : "List of the order taxes", "items" : { "$ref" : "#/components/schemas/OR75_Response_200_Taxes" } } } }, "OR75_Response_200_Taxes" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "description" : "Whether or not the tax is active on the plateform" }, "code" : { "type" : "string", "description" : "Tax code" }, "included_in_commission" : { "type" : "boolean", "description" : "Included in commission" }, "label" : { "type" : "string", "description" : "Tax label" }, "operator_withheld" : { "type" : "boolean", "description" : "Whether or not the tax is withheld by operator" }, "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." } } }, "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" } } }, "P11_Response_200_Products_Measurement" : { "type" : "object", "properties" : { "total_measurement_of_product" : { "type" : "number", "description" : "Product total measurement" }, "unit" : { "type" : "string", "description" : "Product measurement 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", "description" : "Available end date" }, "available_start_date" : { "type" : "string", "format" : "date-time", "description" : "Available start date" }, "channels" : { "type" : "array", "description" : "List of channel codes on which the offer can be sold", "items" : { "type" : "string" } }, "currency_iso_code" : { "type" : "string", "description" : "The currency of the shop (iso format)" }, "description" : { "type" : "string", "description" : "Offer description" }, "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", "description" : "Favorite rank for the offer, when the favorite feature is enabled and the offer is a favorite" }, "fulfillment" : { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_Fulfillment", "description" : "Fulfillment information" }, "inactivity_reasons" : { "type" : "array", "description" : "Reasons for offers inactivity, mandatory if an offer is inactive", "items" : { "type" : "string" } }, "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", "description" : "The logistic class associated to the offer" }, "max_order_quantity" : { "type" : "integer", "format" : "int32", "description" : "The highest quantity of product items per order" }, "min_order_quantity" : { "type" : "integer", "format" : "int32", "description" : "The lowest quantity of product items per order" }, "min_quantity_alert" : { "type" : "integer", "format" : "int32", "description" : "Minimum quantity of the offer" }, "min_shipping_price" : { "type" : "number", "description" : "Unit price of the minimum shipping rate" }, "min_shipping_price_additional" : { "type" : "number", "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" }, "model" : { "type" : "string", "description" : "Shop platform model, current possible values :\n" }, "msrp" : { "type" : "number", "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", "description" : "Custom fields of the offer", "items" : { "$ref" : "#/components/schemas/P11_Response_200_Products_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" }, "premium" : { "type" : "boolean", "description" : "Shop is premium" }, "price" : { "type" : "number", "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_tax_code" : { "type" : "string", "description" : "Product tax code of the offer" }, "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/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", "description" : "Grade of the shop which proposes the offer" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Identifier of the shop which proposes the offer" }, "shop_name" : { "type" : "string", "description" : "Name of the shop which proposes the offer" }, "shop_sku" : { "type" : "string", "description" : "The offer's shop SKU" }, "state_code" : { "type" : "string", "description" : "Offer condition" }, "total_price" : { "type" : "number", "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/P11_Response_200_Products_Offers_Warehouses" } } } }, "P11_Response_200_Products_Offers_AllPrices" : { "type" : "object", "properties" : { "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", "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", "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", "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" } } } }, "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", "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", "description" : "Unit discount price for this quantity threshold" }, "unit_origin_price" : { "type" : "number", "description" : "Unit price for this quantity threshold" } } }, "P11_Response_200_Products_Offers_ApplicablePricing" : { "type" : "object", "properties" : { "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", "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", "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", "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" } } } }, "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", "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", "description" : "Unit discount price for this quantity threshold" }, "unit_origin_price" : { "type" : "number", "description" : "Unit price for this quantity threshold" } } }, "P11_Response_200_Products_Offers_Discount" : { "type" : "object", "deprecated" : true, "properties" : { "discount_price" : { "type" : "number", "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", "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", "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" } } }, "P11_Response_200_Products_Offers_EcoContributions" : { "type" : "object", "properties" : { "eco_contribution_amount" : { "type" : "number", "description" : "Amount of the eco-contribution." }, "epr_category_code" : { "type" : "string", "description" : "Extended Producer Responsibility (EPR) category code.", "maxLength" : 255, "minLength" : 0 }, "producer_id" : { "type" : "string", "description" : "Producer identifier of the eco-contribution.", "maxLength" : 255, "minLength" : 0 } } }, "P11_Response_200_Products_Offers_Fulfillment" : { "type" : "object", "properties" : { "center" : { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_Fulfillment_Center", "description" : "Fulfillment center code" } } }, "P11_Response_200_Products_Offers_Fulfillment_Center" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Center code" } } }, "P11_Response_200_Products_Offers_LogisticClass" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Logistic class code" }, "label" : { "type" : "string", "description" : "Logistic class label" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields" : { "type" : "object", "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" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Boolean" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Link" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_List" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_MultipleValuesList" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "array", "description" : "Values of the custom field", "items" : { "type" : "string" } } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Numeric" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Regex" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's value" } } }, "P11_Response_200_Products_Offers_OfferAdditionalFields_Textarea" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/P11_Response_200_Products_Offers_OfferAdditionalFields" } ], "properties" : { "value" : { "type" : "string", "description" : "Custom field's 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", "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", "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", "description" : "Original retail price for a quantity of one, i.e. the retail price for a quantity of one regardless of the discounts." } } }, "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" }, "shipping_price_unit" : { "type" : "number", "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" } } }, "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" } } }, "P11_Response_200_Products_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" } } }, "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...)" } } }, "P11_Response_200_Products_ProductReferences" : { "type" : "object", "properties" : { "reference" : { "type" : "string", "description" : "Value of the reference" }, "reference_type" : { "type" : "string", "description" : "Type of the reference" } } }, "P31_Response_200" : { "type" : "object", "properties" : { "products" : { "type" : "array", "description" : "Products", "items" : { "$ref" : "#/components/schemas/P31_Response_200_Products" } } } }, "P31_Response_200_Products" : { "type" : "object", "properties" : { "authorized_shop_ids" : { "type" : "array", "description" : "List of the shop ids that are allowed to sell this product, or an empty list if there is no restriction on this product", "items" : { "type" : "string" } }, "category_code" : { "type" : "string", "description" : "Product category code" }, "category_label" : { "type" : "string", "description" : "Product category label" }, "product_id" : { "type" : "string", "description" : "Product ID" }, "product_id_type" : { "type" : "string", "description" : "Product ID type" }, "product_sku" : { "type" : "string", "description" : "Product SKU" }, "product_title" : { "type" : "string", "description" : "Product title" } } }, "P42_Response_200" : { "type" : "object", "properties" : { "conversion_options" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions", "description" : "Options used for the conversion" }, "conversion_type" : { "type" : "string", "description" : "Type of conversion applied on products" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Returns true if error report is available. Value is filled when the import status is COMPLETE." }, "has_new_product_report" : { "type" : "boolean", "description" : "Returns true if new product report is available. Value is filled when the import status is COMPLETE." }, "has_transformation_error_report" : { "type" : "boolean", "description" : "Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE." }, "has_transformed_file" : { "type" : "boolean", "description" : "Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE." }, "import_id" : { "type" : "integer", "format" : "int64", "description" : "Import identifier" }, "import_status" : { "type" : "string", "description" : "Import status" }, "integration_details" : { "$ref" : "#/components/schemas/P42_Response_200_IntegrationDetails", "description" : "Integration details" }, "reason_status" : { "type" : "string", "description" : "A message explaining the reason of the import status, if relevant" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "transform_lines_in_error" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in error" }, "transform_lines_in_success" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in success" }, "transform_lines_read" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines read" }, "transform_lines_with_warning" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines with warning" } } }, "P42_Response_200_ConversionOptions" : { "type" : "object", "properties" : { "ai_enrichment" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiEnrichment", "description" : "Enable AI enrichment" }, "ai_rewrite" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiRewrite", "description" : "Enable AI rewrite" }, "ai_translation" : { "$ref" : "#/components/schemas/P42_Response_200_ConversionOptions_AiTranslation", "description" : "Enable AI translation" } } }, "P42_Response_200_ConversionOptions_AiEnrichment" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P42_Response_200_ConversionOptions_AiRewrite" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P42_Response_200_ConversionOptions_AiTranslation" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P42_Response_200_IntegrationDetails" : { "type" : "object", "properties" : { "invalid_products" : { "type" : "integer", "format" : "int64", "description" : "Number of invalid products" }, "products_not_accepted_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been accepted in the required time" }, "products_not_synchronized_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been synchronized in the required time" }, "products_reimported" : { "type" : "integer", "format" : "int64", "description" : "Number of products that have been reimported in a more recent file" }, "products_successfully_synchronized" : { "type" : "integer", "format" : "int64", "description" : "Number of products successfully synchronized on operator system" }, "products_with_synchronization_issues" : { "type" : "integer", "format" : "int64", "description" : "Number of products having synchronization issues with operator system" }, "products_with_wrong_identifiers" : { "type" : "integer", "format" : "int64", "description" : "Number of products having wrong identifiers" }, "rejected_products" : { "type" : "integer", "format" : "int64", "description" : "Number of rejected products by operator system" } } }, "P51_Response_200" : { "type" : "object", "properties" : { "product_import_trackings" : { "type" : "array", "description" : "List of product import status information", "items" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings" } }, "total_count" : { "type" : "integer", "format" : "int32", "description" : "Total count of product import status information" } } }, "P51_Response_200_ProductImportTrackings" : { "type" : "object", "properties" : { "conversion_options" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions", "description" : "Options used for the conversion" }, "conversion_type" : { "type" : "string", "description" : "Type of conversion applied on products" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Returns true if error report is available. Value is filled when the import status is COMPLETE." }, "has_new_product_report" : { "type" : "boolean", "description" : "Returns true if new product report is available. Value is filled when the import status is COMPLETE." }, "has_transformation_error_report" : { "type" : "boolean", "description" : "Returns true if transformation error report is available. Value is filled when the import status is SENT or COMPLETE." }, "has_transformed_file" : { "type" : "boolean", "description" : "Returns true if transformed file is available. Value is filled when the import status is SENT or COMPLETE." }, "import_id" : { "type" : "integer", "format" : "int64", "description" : "Import identifier" }, "import_status" : { "type" : "string", "description" : "Import status" }, "integration_details" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_IntegrationDetails", "description" : "Integration details" }, "reason_status" : { "type" : "string", "description" : "A message explaining the reason of the import status, if relevant" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "transform_lines_in_error" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in error" }, "transform_lines_in_success" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines in success" }, "transform_lines_read" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines read" }, "transform_lines_with_warning" : { "type" : "integer", "format" : "int64", "description" : "Total count of transformed lines with warning" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions" : { "type" : "object", "properties" : { "ai_enrichment" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment", "description" : "Enable AI enrichment" }, "ai_rewrite" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite", "description" : "Enable AI rewrite" }, "ai_translation" : { "$ref" : "#/components/schemas/P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation", "description" : "Enable AI translation" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiEnrichment" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiRewrite" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P51_Response_200_ProductImportTrackings_ConversionOptions_AiTranslation" : { "type" : "object", "properties" : { "status" : { "type" : "string" } } }, "P51_Response_200_ProductImportTrackings_IntegrationDetails" : { "type" : "object", "properties" : { "invalid_products" : { "type" : "integer", "format" : "int64", "description" : "Number of invalid products" }, "products_not_accepted_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been accepted in the required time" }, "products_not_synchronized_in_time" : { "type" : "integer", "format" : "int64", "description" : "Number of products that haven't been synchronized in the required time" }, "products_reimported" : { "type" : "integer", "format" : "int64", "description" : "Number of products that have been reimported in a more recent file" }, "products_successfully_synchronized" : { "type" : "integer", "format" : "int64", "description" : "Number of products successfully synchronized on operator system" }, "products_with_synchronization_issues" : { "type" : "integer", "format" : "int64", "description" : "Number of products having synchronization issues with operator system" }, "products_with_wrong_identifiers" : { "type" : "integer", "format" : "int64", "description" : "Number of products having wrong identifiers" }, "rejected_products" : { "type" : "integer", "format" : "int64", "description" : "Number of rejected products by operator system" } } }, "PC01_Response_200" : { "type" : "object", "properties" : { "features" : { "$ref" : "#/components/schemas/PC01_Response_200_Features", "description" : "Features activated on the platform" }, "modules" : { "$ref" : "#/components/schemas/PC01_Response_200_Modules", "description" : "Modules activated on the platform" }, "platform_configuration" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration", "description" : "High level platform configurations" }, "platform_name" : { "type" : "string", "description" : "Operator platform name" }, "tenant_name" : { "type" : "string", "description" : "Tenant platform name" }, "timezone" : { "type" : "string", "description" : "Platform timezone" } } }, "PC01_Response_200_Features" : { "type" : "object", "properties" : { "catalog" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Catalog", "description" : "Catalog related features" }, "circular_economy_data_collection" : { "type" : "boolean", "description" : "Allows operators to collect data related to the circular economy regulation" }, "competitive_pricing_tool" : { "type" : "boolean", "description" : "The competitive pricing tool allows stores to view and possibly match competing Marketplace offers" }, "direct_payment_customer_store" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_DirectPaymentCustomerStore", "description" : "Allows transactions taking place outside of Mirakl between customers and sellers" }, "disable_seller_alternative_carrier" : { "type" : "boolean", "description" : "Prevent stores from specifying alternatives carriers outside those predefined by the operator" }, "dropship" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Dropship", "description" : "Dropship related features" }, "kyc_status_per_seller" : { "type" : "boolean", "description" : "Allows PSPs to provide operators with seller KYC statuses" }, "lead_time_to_ship_by_sellers_enabled" : { "type" : "string", "description" : "Allows sellers to override the default lead time to ship" }, "multi_currency" : { "type" : "boolean", "description" : "Defines if platform support multi currencies" }, "multi_payout_psp_per_seller" : { "type" : "boolean", "description" : "Allows the operator to use Hybrid pay-out PSP feature" }, "no_reply_needed" : { "type" : "boolean", "description" : "Allows to end order-related conversations when the last message sent from customer does not specifically require a reply" }, "offer_prices_decimals" : { "type" : "string", "description" : "Defines maximum number of decimals in offer prices" }, "operator_csv_delimiter" : { "type" : "string", "description" : "The delimiter used in the CSV files exported from the back office. COMMA: ',' delimiter. SEMICOLON: ';' delimiter." }, "order_conditions" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_OrderConditions", "description" : "Order conditions related features activated" }, "order_tax_mode" : { "type" : "string", "description" : "Prices with tax included or excluded in order-related APIs. TAX_INCLUDED: Prices with tax included. TAX_EXCLUDED: Prices with tax excluded." }, "order_workflows" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_OrderWorkflows", "description" : "Order workflows activated" }, "payment_confirmation" : { "type" : "boolean", "description" : "Allows the operator to mark an accounting document as \"Paid\" when the corresponding amount is confirmed to be paid to the seller" }, "pricing" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Pricing", "description" : "Pricing related features activated" }, "product_data_validation_by_channel" : { "type" : "boolean", "deprecated" : true, "description" : "Facilitates the management of attributes in a multilingual context" }, "promotion" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Promotion", "description" : "Promotion related features activated" }, "returns" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Returns", "description" : "Returns management feature activated" }, "shipment" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Shipment", "description" : "Shipment related features activated" }, "shop_tax_options" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions", "description" : "Tax-related options for professional shops" }, "tax_collection" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_TaxCollection", "description" : "Allows the collection of information required to calculate taxes, with or without the tax connector" }, "tax_id_number" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_TaxIdNumber", "description" : "Unique identifier used to conduct tax-related formalities" }, "warehouses" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_Warehouses", "description" : "Allows operators to apply specific configuration on store account warehouses" } } }, "PC01_Response_200_Features_Catalog" : { "type" : "object", "properties" : { "allow_shop_contribution_to_all_channels" : { "type" : "boolean", "description" : "Allows shops to contribute data to all sales channels when enabled; otherwise, data can only be pushed to channels the shop belongs to" }, "exclude_invalid_products" : { "type" : "boolean", "description" : "When enabled, products with validation errors will be excluded from product imports and won't be transmitted to MCM" }, "list_of_multiple_values_separator" : { "type" : "string", "description" : "Character used to separate values in the 'Multiple Values List' type attributes" }, "product_acceptance_by_channel" : { "type" : "boolean", "description" : "Allows operators to accept or reject products according to sales channels" }, "product_data_validation_by_channel" : { "type" : "boolean", "description" : "Facilitates the management of attributes in a multilingual context" }, "product_import_only_on_leaf" : { "type" : "boolean", "description" : "Prevents the import of products into non-leaf categories" } } }, "PC01_Response_200_Features_DirectPaymentCustomerStore" : { "type" : "object", "properties" : { "activated" : { "type" : "boolean", "description" : "Direct payment customer store activated" }, "refund_cancel_authorized" : { "type" : "boolean", "description" : "Allows refund and cancelation for transactions taking place outside of Mirakl between customers and sellers" } } }, "PC01_Response_200_Features_Dropship" : { "type" : "object", "properties" : { "retail_pricing_edition_enabled" : { "type" : "string", "description" : "Retail pricing edition enabled" }, "retail_pricing_enabled" : { "type" : "boolean", "description" : "Retail pricing activated on dropship offers" } } }, "PC01_Response_200_Features_OrderConditions" : { "type" : "object", "properties" : { "lead_time_to_ship" : { "type" : "boolean", "deprecated" : true, "description" : "Allows sellers to inform a lead time to ship on their offers" }, "maximum_order_quantity" : { "type" : "boolean", "description" : "Allows sellers to request for a maximum order quantity" }, "minimum_order_quantity" : { "type" : "boolean", "description" : "Allows sellers to request for a minimum order quantity" }, "package_order_quantity" : { "type" : "boolean", "description" : "Allows sellers to set an order quantity increment" } } }, "PC01_Response_200_Features_OrderWorkflows" : { "type" : "object", "properties" : { "no_customer_payment_confirmation" : { "type" : "boolean", "description" : "Allows seller payments to be completely separated from customer debits" }, "order_acceptance" : { "type" : "string", "description" : "Indicate if shop accounts must accept new orders and take responsibility for the transaction. NOT_AUTOMATIC: All shop accounts must accept their orders manually. AUTOMATIC: Orders are automatically accepted. BOTH: AUTOMATIC or NOT_AUTOMATIC mode depending on the store account" }, "pause_debit_workflow" : { "type" : "boolean", "description" : "Pause the order debit workflow when taxes must be recalculated" }, "pay_on_due_date" : { "type" : "boolean", "description" : "Allows professionals to pay their orders after the receipt of the items or an explicit invoice" }, "pay_on_shipment" : { "type" : "boolean", "description" : "Allows operators to debit orders before they have been fully shipped" }, "sellers_edit_shipping_origin" : { "type" : "boolean", "description" : "Allow shop accounts to edit shipping origin to ensures accurate tax calculations with shipping origin data" }, "shipping_and_billing_details_before_acceptance" : { "type" : "boolean", "description" : "Indicate if shipping and billing details are displayed before order acceptance" } } }, "PC01_Response_200_Features_Pricing" : { "type" : "object", "properties" : { "channel_pricing" : { "type" : "string", "description" : "Allows sellers to create prices applicable on the operator’s different storefronts materialized as sales channels in Mirakl. DISABLED: No channel pricing. SINGLE: Allows sellers to create one price per channel. MULTI: Allows sellers to create multiple prices per channel." }, "discount_period_required" : { "type" : "boolean", "description" : "Requires sellers to set start and end dates when creating or updating discounts on default and specific prices." }, "discount_price_creation_in_the_past_blocked" : { "type" : "boolean", "description" : "Prevents sellers from setting discount end dates in the past for their default and specific prices." }, "scheduled_pricing" : { "type" : "boolean", "description" : "Allows sellers to set up multiple prices in advance" }, "volume_discount" : { "type" : "boolean", "description" : "Allows discounts for bulk purchases" }, "volume_pricing" : { "type" : "boolean", "description" : "Allows pricing for bulk purchases" } } }, "PC01_Response_200_Features_Promotion" : { "type" : "object", "properties" : { "cart_promotion_campaign" : { "type" : "boolean", "description" : "Allows the operator to create cart promotion campaigns." }, "discount_campaign" : { "type" : "boolean", "description" : "Allows the operator to create discount campaigns." }, "seller_promotion" : { "type" : "boolean", "description" : "Allows stores to create promotions." } } }, "PC01_Response_200_Features_Returns" : { "type" : "object", "properties" : { "drop_ship" : { "type" : "boolean", "description" : "Enables returns management in Drop ship" }, "marketplace" : { "type" : "boolean", "description" : "Enables returns management in Marketplace" }, "one_creditor" : { "type" : "boolean", "description" : "Enables returns management in One creditor" } } }, "PC01_Response_200_Features_Shipment" : { "type" : "object", "properties" : { "multi_part_item_shipment" : { "type" : "boolean", "description" : "Allows sellers to create several packages for a same item in an order" }, "multi_shipment" : { "type" : "boolean", "description" : "Allows sellers to create several shipments for a same order" } } }, "PC01_Response_200_Features_ShopTaxOptions" : { "type" : "object", "properties" : { "local_tax_number" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber", "description" : "The VAT/GST number of a seller billing information and fiscal representative" }, "tax_identification_number" : { "$ref" : "#/components/schemas/PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber", "description" : "The tax identification number of a seller billing information" } } }, "PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber" : { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Defines if the VAT/GST number is mandatory" }, "validation_regex" : { "type" : "string", "description" : "Regular expression that the VAT/GST number must match" } } }, "PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber" : { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Defines if the tax identification number is mandatory" }, "validation_regex" : { "type" : "string", "description" : "Regular expression that the tax identification number must match" } } }, "PC01_Response_200_Features_TaxCollection" : { "type" : "object", "properties" : { "activated" : { "type" : "string", "description" : "Tax collection activated. NO: Not activated. YES: Activated for all stores. YES_PER_STORE: Activated for some stores." }, "product_tax_code_mandatory" : { "type" : "boolean", "description" : "Product tax code mandatory at offer level" }, "tax_collection_by_operator" : { "type" : "boolean", "description" : "Operator in charge of tax collection on behalf of sellers" } } }, "PC01_Response_200_Features_TaxIdNumber" : { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Tax ID number mandatory" }, "validation_regex" : { "type" : "string", "description" : "Regular expression to match for sellers tax number ID" } } }, "PC01_Response_200_Features_Warehouses" : { "type" : "object", "properties" : { "geolocation" : { "type" : "boolean", "description" : "Geolocation on warehouses activated" }, "restricted_countries" : { "type" : "array", "description" : "The list of the restricted countries applying on warehouses. Format ISO 3166-1 alpha-3 code (3 letters country code). Possible values : AFG, ALA, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, KHM, CMR, CAN, CPV, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COG, COD, COK, CRI, CIV, HRV, CUB, CUW, CYP, CZE, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MKD, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SUR, SJM, SWZ, SWE, CHE, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, USA, UMI, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, YEM, ZMB, ZWE", "items" : { "type" : "string" } } } }, "PC01_Response_200_Modules" : { "type" : "object", "properties" : { "mirakl_catalog_integrator" : { "type" : "boolean", "description" : "Mirakl Catalog integrator activated. Allows operator to manage catalog structure into Mirakl." }, "mirakl_catalog_manager" : { "type" : "boolean", "description" : "Mirakl Catalog Manager activated. Allows operator to remove the complexity of integrating catalogs from multiple sources." }, "mirakl_catalog_transformer" : { "type" : "boolean", "description" : "Mirakl Catalog Transformer activated." }, "mirakl_platform_services" : { "type" : "boolean", "description" : "Mirakl Platform for Services activated. Specific module for services management: separated from the product management module." }, "offer_management" : { "type" : "boolean", "description" : "Offer management available on the platform" }, "offer_management_mode" : { "type" : "string", "description" : "Offer management mode on the platform: SIMPLE: All shops can push offers. HYBRID: The operator decides whether a shop can push offers on the platform." }, "order_management" : { "type" : "boolean", "description" : "Order management available on the platform" }, "order_management_mode" : { "type" : "string", "description" : "Order management mode on the platform: SIMPLE: All shops can process orders. HYBRID: The operator decides whether a shop can process orders on the platform." }, "promotions" : { "type" : "boolean", "deprecated" : true, "description" : "Deprecated: Promotion availability is now controlled by operator settings (cart_promotion_campaign and seller_promotion)." }, "quotes" : { "type" : "boolean", "description" : "Quote module activated" }, "tax_manager" : { "$ref" : "#/components/schemas/PC01_Response_200_Modules_TaxManager", "deprecated" : true, "description" : "Allows operator to be connected with a tax calculation provider" } } }, "PC01_Response_200_Modules_TaxManager" : { "type" : "object", "deprecated" : true, "properties" : { "activated" : { "type" : "boolean", "description" : "Tax Manager activated" }, "tax_provider" : { "$ref" : "#/components/schemas/PC01_Response_200_Modules_TaxManager_TaxProvider", "description" : "The tax provider processing tax estimation" } } }, "PC01_Response_200_Modules_TaxManager_TaxProvider" : { "type" : "object", "properties" : { "avalara" : { "type" : "boolean", "description" : "Avalara configured as tax provider" }, "vertex" : { "type" : "boolean", "description" : "Vertex configured as tax provider" } } }, "PC01_Response_200_PlatformConfiguration" : { "type" : "object", "properties" : { "customer_model" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration_CustomerModel", "description" : "The customer organization activation on the platform" }, "enhanced_seller_invoicing" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing", "description" : "Enhanced seller invoicing activation on the platform" }, "platform_model" : { "$ref" : "#/components/schemas/PC01_Response_200_PlatformConfiguration_PlatformModel", "description" : "The platform models activated on the platform " } } }, "PC01_Response_200_PlatformConfiguration_CustomerModel" : { "type" : "object", "properties" : { "b2b" : { "type" : "boolean", "description" : "Customer model Business to Business is enabled: if true, customers can be linked to a customer organization" }, "b2c" : { "type" : "boolean", "description" : "Customer model Business to Customer is enabled: if true, customers can be created without being linked to a customer organization" } } }, "PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Enhanced seller invoicing activated." } } }, "PC01_Response_200_PlatformConfiguration_PlatformModel" : { "type" : "object", "properties" : { "drop_ship" : { "type" : "boolean", "description" : "Drop ship platform model activated" }, "marketplace" : { "type" : "boolean", "description" : "Marketplace platform model activated" }, "one_creditor" : { "type" : "boolean", "description" : "One creditor platform model activated" } } }, "PL11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/PL11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "PL11_Response_200_Data" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Picklist creation date" }, "id" : { "type" : "string", "description" : "Picklist identifier" }, "last_updated" : { "type" : "string", "format" : "date-time", "description" : "Picklist last update date" }, "order_lines" : { "type" : "array", "description" : "Picklist order line identifiers", "items" : { "$ref" : "#/components/schemas/PL11_Response_200_Data_OrderLines" } }, "picklist_lines" : { "type" : "array", "description" : "Picklist lines", "items" : { "$ref" : "#/components/schemas/PL11_Response_200_Data_PicklistLines" } }, "pickrun_code" : { "type" : "string", "description" : "Pickrun code" }, "pickup_date" : { "type" : "string", "format" : "date-time", "description" : "Pickup date" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Picklist shop identifier" }, "state" : { "type" : "string", "description" : "Picklist state" } } }, "PL11_Response_200_Data_OrderLines" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Picklist order line id" } } }, "PL11_Response_200_Data_PicklistLines" : { "type" : "object", "properties" : { "offer_id" : { "type" : "integer", "format" : "int64", "description" : "Identifier of the offer to pick" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity of offers to pick" } } }, "PM11_Response_200" : { "type" : "object", "description" : "JSON output", "properties" : { "attributes" : { "type" : "array", "description" : "List of attributes", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes" } } } }, "PM11_Response_200_Attributes" : { "type" : "object", "properties" : { "channels" : { "type" : "array", "description" : "Channels", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Channels" } }, "code" : { "type" : "string", "description" : "Attribute code" }, "default_value" : { "type" : "string", "deprecated" : true, "description" : "Default value for value list type attributes" }, "description" : { "type" : "string", "description" : "Attribute description" }, "description_translations" : { "type" : "array", "description" : "Translations of the attribute description", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_DescriptionTranslations" } }, "example" : { "type" : "string", "description" : "Attribute example to help sellers when they fill the product creation form" }, "hierarchy_code" : { "type" : "string", "description" : "The code of the hierarchy (category) this attribute belongs to. If this field is empty, the attribute is shared among all hierarchies." }, "label" : { "type" : "string", "description" : "Attribute label" }, "label_translations" : { "type" : "array", "description" : "Translations of the attribute label", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_LabelTranslations" } }, "locale" : { "type" : "string", "description" : "Attribute localization.\n\nThe language format can either be:\n- ISO-639 (E.g. \"en\")\n- ISO-639_ISO-3166 (E.g. \"en_US\")\n" }, "required" : { "type" : "boolean", "deprecated" : true, "description" : "Whether or not the attribute is required" }, "requirement_level" : { "type" : "string", "description" : "Requirement level of the attribute" }, "roles" : { "type" : "array", "description" : "Attribute roles", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles" } }, "transformations" : { "type" : "string", "description" : "Transformations applied to the attribute (a list of transformations separated by commas)" }, "type" : { "type" : "string", "description" : "Attribute type" }, "type_parameter" : { "type" : "string", "deprecated" : true, "description" : "Type parameter" }, "type_parameters" : { "type" : "array", "description" : "Specificities of the attribute type, for example the date format, or the maximum size of a media", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_TypeParameters" } }, "unique_code" : { "type" : "string", "description" : "Unique code of the attribute" }, "validations" : { "type" : "string", "description" : "Validations applied to the attribute (a list of validations separated by commas)" }, "values" : { "type" : "array", "deprecated" : true, "description" : "A list of authorized values for this attribute", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Values" } }, "values_list" : { "type" : "string", "deprecated" : true, "description" : "This code points to the list defining the authorized values for this attribute." }, "variant" : { "type" : "boolean", "description" : "Whether or not the attribute is a variation axis. Possible values: true or false" } } }, "PM11_Response_200_Attributes_Channels" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Channel code" } } }, "PM11_Response_200_Attributes_DescriptionTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "PM11_Response_200_Attributes_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "PM11_Response_200_Attributes_Roles" : { "type" : "object", "properties" : { "parameters" : { "type" : "array", "description" : "Attribute role parameters", "items" : { "$ref" : "#/components/schemas/PM11_Response_200_Attributes_Roles_Parameters" } }, "type" : { "type" : "string", "description" : "Role type of the attribute" } } }, "PM11_Response_200_Attributes_Roles_Parameters" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the parameter" }, "value" : { "type" : "string", "description" : "Value of the parameter" } } }, "PM11_Response_200_Attributes_TypeParameters" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the parameter" }, "value" : { "type" : "string", "description" : "Value of the parameter" } } }, "PM11_Response_200_Attributes_Values" : { "type" : "object", "deprecated" : true, "properties" : { "code" : { "type" : "string", "description" : "Value code" } } }, "PR01_Response_200" : { "type" : "object", "properties" : { "promotions" : { "type" : "array", "description" : "Promotions list", "items" : { "$ref" : "#/components/schemas/PR01_Response_200_Promotions" } }, "total_count" : { "type" : "integer", "format" : "int32" } } }, "PR01_Response_200_Promotions" : { "type" : "object", "properties" : { "amount_off" : { "type" : "number", "description" : "The amount off of the promotion.
    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 for the shop. Beware: this identifier is unique per shop, not platform-wide. To uniquely identify a promotion, use the couple (shop_id, internal_id)." }, "last_updated" : { "type" : "string", "format" : "date-time", "description" : "Last update date of the promotion" }, "max_quantity_to_discount" : { "type" : "integer", "format" : "int32", "description" : "Maximum quantity of items on which a percentage off discount applies. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise" }, "medias" : { "type" : "array", "description" : "The medias associated with this promotion, with the locales they apply to", "items" : { "$ref" : "#/components/schemas/PR01_Response_200_Promotions_Medias" } }, "percentage_off" : { "type" : "number", "description" : "The percentage off of the promotion.
    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", "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" } }, "reward_on_purchased_items" : { "type" : "boolean", "description" : "Specifies if the promotion's reward applies to purchased items or to a specific selection" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop unique identifier" }, "start_date" : { "type" : "string", "format" : "date-time", "description" : "Start date of the promotion period of activity" }, "state" : { "type" : "string", "description" : "Promotion state" }, "trigger_offer_ids" : { "type" : "array", "description" : "Offers which trigger the promotion, according to the requested trigger_offer_ids", "items" : { "type" : "integer", "format" : "int64" } }, "triggers" : { "type" : "array", "description" : "Triggers of the promotion", "items" : { "$ref" : "#/components/schemas/PR01_Response_200_Promotions_Triggers" } }, "type" : { "type" : "string", "description" : "Promotion type" } } }, "PR01_Response_200_Promotions_ApplicationToCart" : { "type" : "object", "properties" : { "promo_code" : { "type" : "string", "description" : "Promo code associated to the promotion" } } }, "PR01_Response_200_Promotions_Campaign" : { "type" : "object", "properties" : { "identifier" : { "type" : "string", "description" : "Identifier of the campaign" } } }, "PR01_Response_200_Promotions_Channels" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Channel code" }, "label" : { "type" : "string", "description" : "Channel label" } } }, "PR01_Response_200_Promotions_Medias" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Media's locale" }, "url" : { "type" : "string", "description" : "Url to download the media" } } }, "PR01_Response_200_Promotions_PublicDescriptions" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Description's locale" }, "value" : { "type" : "string", "description" : "The description itself" } } }, "PR01_Response_200_Promotions_Triggers" : { "type" : "object", "properties" : { "amount_purchased" : { "type" : "number", "description" : "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers." }, "quantity_purchased" : { "type" : "integer", "format" : "int32", "description" : "Quantity of items that triggers the promotion. Available for minimum_quantity or every_quantity type triggers." }, "same_item_purchased" : { "type" : "boolean", "description" : "Whether the promotion requires the same item to be triggered or not. Available for minimum_quantity or every_quantity type triggers." }, "type" : { "type" : "string", "description" : "Type of promotion trigger" } } }, "PR03_Request" : { "type" : "object", "properties" : { "application_to_cart" : { "type" : "array", "description" : "If applicable, promo code to associate to the promotion", "items" : { "$ref" : "#/components/schemas/PR03_Request_ApplicationToCart" } }, "channel_codes" : { "type" : "array", "description" : "Channels on which the promotion is applied. If none, promotion applied on all channels", "items" : { "type" : "string" } }, "customer_group_ids" : { "type" : "array", "description" : "The customer groups on which the promotion is applied. If none, promotion applies to all customer groups.", "items" : { "type" : "string" } }, "customer_organization_ids" : { "type" : "array", "description" : "The customer organizations on which the promotion is applied. If none, promotion applies to all customer organizations.", "items" : { "type" : "string" } }, "end_date" : { "type" : "string", "format" : "date-time", "description" : "End date of the promotion period of activity" }, "internal_description" : { "type" : "string", "description" : "Internal description of the promotion, set by the shop" }, "internal_id" : { "type" : "string", "description" : "Promotion identifier" }, "public_descriptions" : { "type" : "array", "description" : "The public descriptions of the promotion, with the locales they apply to", "items" : { "$ref" : "#/components/schemas/PR03_Request_PublicDescriptions" } }, "reward" : { "$ref" : "#/components/schemas/PR03_Request_Reward", "description" : "Defines the reward applied when promotion is triggered" }, "start_date" : { "type" : "string", "format" : "date-time", "description" : "Start date of the promotion period of activity" }, "trigger" : { "$ref" : "#/components/schemas/PR03_Request_Trigger", "description" : "Trigger of the promotion" } } }, "PR03_Request_ApplicationToCart" : { "type" : "object", "description" : "If applicable, promo code to associate to the promotion", "properties" : { "promo_code" : { "type" : "string", "description" : "Promo code associated to the promotion" } } }, "PR03_Request_PublicDescriptions" : { "type" : "object", "description" : "The public descriptions of the promotion, with the locales they apply to", "properties" : { "locale" : { "type" : "string", "description" : "Description's locale" }, "value" : { "type" : "string", "description" : "The description itself" } } }, "PR03_Request_Reward" : { "type" : "object", "description" : "Defines the reward applied when promotion is triggered", "discriminator" : { "mapping" : { "AMOUNT_OFF" : "#/components/schemas/PR03_Request_Reward_AmountOff", "FREE_ITEMS" : "#/components/schemas/PR03_Request_Reward_FreeItems", "PERCENTAGE_OFF" : "#/components/schemas/PR03_Request_Reward_PercentageOff", "REDUCED_UNIT_PRICE" : "#/components/schemas/PR03_Request_Reward_ReducedUnitPrice" }, "propertyName" : "type" }, "properties" : { "selection" : { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection", "description" : "The product assortment receiving the reward" }, "type" : { "type" : "string", "description" : "Type of promotion reward" } } }, "PR03_Request_Reward_AmountOff" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward" } ], "properties" : { "amount_off" : { "type" : "number", "description" : "The amount off of the promotion." } } }, "PR03_Request_Reward_FreeItems" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward" } ], "properties" : { "free_items_quantity" : { "type" : "integer", "format" : "int32", "description" : "The free item target quantity of the promotion." } } }, "PR03_Request_Reward_PercentageOff" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward" } ], "properties" : { "max_quantity_to_discount" : { "type" : "integer", "format" : "int32", "description" : "Maximum quantity of items on which a percentage off discount applies." }, "percentage_off" : { "type" : "number", "description" : "The percentage off of the promotion." } } }, "PR03_Request_Reward_ReducedUnitPrice" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward" } ], "properties" : { "max_quantity_to_discount" : { "type" : "integer", "format" : "int32", "description" : "Maximum quantity of items on which a reduced unit price discount applies." }, "reduced_unit_price" : { "type" : "number", "description" : "The new offer's unit price triggered by the promotion." } } }, "PR03_Request_Reward_Selection" : { "type" : "object", "discriminator" : { "mapping" : { "BRAND" : "#/components/schemas/PR03_Request_Reward_Selection_Brand", "CATEGORY" : "#/components/schemas/PR03_Request_Reward_Selection_Category", "OFFER" : "#/components/schemas/PR03_Request_Reward_Selection_Offer", "PRODUCT" : "#/components/schemas/PR03_Request_Reward_Selection_Product", "PURCHASED_ITEMS" : "#/components/schemas/PR03_Request_Reward_Selection_PurchasedItems" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "The type of assortment selection for the reward" } } }, "PR03_Request_Reward_Selection_Brand" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR03_Request_Reward_Selection_Category" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR03_Request_Reward_Selection_Offer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR03_Request_Reward_Selection_Product" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection_Product_Values" } } } }, "PR03_Request_Reward_Selection_Product_Values" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Reference type (e.g., SKU, EAN, UPC)" }, "value" : { "type" : "string", "description" : "Reference value" } } }, "PR03_Request_Reward_Selection_PurchasedItems" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Reward_Selection" } ] }, "PR03_Request_Trigger" : { "type" : "object", "description" : "Trigger of the promotion", "discriminator" : { "mapping" : { "EVERY_AMOUNT" : "#/components/schemas/PR03_Request_Trigger_EveryAmount", "EVERY_QUANTITY" : "#/components/schemas/PR03_Request_Trigger_EveryQuantity", "MINIMUM_AMOUNT" : "#/components/schemas/PR03_Request_Trigger_MinimumAmount", "MINIMUM_QUANTITY" : "#/components/schemas/PR03_Request_Trigger_MinimumQuantity" }, "propertyName" : "type" }, "properties" : { "selection" : { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection", "description" : "The product assortment triggering the promotion" }, "type" : { "type" : "string", "description" : "Type of promotion trigger" } } }, "PR03_Request_Trigger_EveryAmount" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger" } ], "properties" : { "amount_purchased" : { "type" : "number", "description" : "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers." } } }, "PR03_Request_Trigger_EveryQuantity" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger" } ], "properties" : { "quantity_purchased" : { "type" : "integer", "format" : "int32", "description" : "Quantity of items that triggers the promotion. Available for minimum_quantity or every_quantity type triggers." }, "same_item_purchased" : { "type" : "boolean", "description" : "Whether the promotion requires the same item to be triggered or not. Available for minimum_quantity or every_quantity type triggers." } } }, "PR03_Request_Trigger_MinimumAmount" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger" } ], "properties" : { "amount_purchased" : { "type" : "number", "description" : "Amount that triggers the promotion. Available for minimum_amount or every_amount type triggers." } } }, "PR03_Request_Trigger_MinimumQuantity" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger" } ], "properties" : { "quantity_purchased" : { "type" : "integer", "format" : "int32", "description" : "Quantity of items that triggers the promotion. Available for minimum_quantity or every_quantity type triggers." }, "same_item_purchased" : { "type" : "boolean", "description" : "Whether the promotion requires the same item to be triggered or not. Available for minimum_quantity or every_quantity type triggers." } } }, "PR03_Request_Trigger_Selection" : { "type" : "object", "discriminator" : { "mapping" : { "ALL" : "#/components/schemas/PR03_Request_Trigger_Selection_All", "BRAND" : "#/components/schemas/PR03_Request_Trigger_Selection_Brand", "CATEGORY" : "#/components/schemas/PR03_Request_Trigger_Selection_Category", "OFFER" : "#/components/schemas/PR03_Request_Trigger_Selection_Offer", "PRODUCT" : "#/components/schemas/PR03_Request_Trigger_Selection_Product" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "The type of assortment selection for the trigger" } } }, "PR03_Request_Trigger_Selection_All" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection" } ] }, "PR03_Request_Trigger_Selection_Brand" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR03_Request_Trigger_Selection_Category" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR03_Request_Trigger_Selection_Offer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR03_Request_Trigger_Selection_Product" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "$ref" : "#/components/schemas/PR03_Request_Trigger_Selection_Product_Values" } } } }, "PR03_Request_Trigger_Selection_Product_Values" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Reference type (e.g., SKU, EAN, UPC)" }, "value" : { "type" : "string", "description" : "Reference value" } } }, "PR04_Request" : { "type" : "object", "properties" : { "application_to_cart" : { "type" : "array", "description" : "If applicable, promo code associated to the promotion. Only editable if promotion is upcoming.", "items" : { "$ref" : "#/components/schemas/PR04_Request_ApplicationToCart" } }, "channel_codes" : { "type" : "array", "description" : "Channels on which the promotion is applied. If none, promotion applied on all channels", "items" : { "type" : "string" } }, "customer_group_ids" : { "type" : "array", "description" : "The customer groups on which the promotion is applied. If none, promotion applies to all customer groups.", "items" : { "type" : "string" } }, "customer_organization_ids" : { "type" : "array", "description" : "The customer organizations on which the promotion is applied. If none, promotion applies to all customer organizations.", "items" : { "type" : "string" } }, "end_date" : { "type" : "string", "format" : "date-time", "description" : "End date of the promotion period of activity" }, "internal_description" : { "type" : "string", "description" : "Internal description of the promotion, set by the shop" }, "public_descriptions" : { "type" : "array", "description" : "The public descriptions of the promotion, with the locales they apply to", "items" : { "$ref" : "#/components/schemas/PR04_Request_PublicDescriptions" } }, "reward" : { "$ref" : "#/components/schemas/PR04_Request_Reward", "description" : "Defines the reward applied when promotion is triggered" }, "start_date" : { "type" : "string", "format" : "date-time", "description" : "Start date of the promotion period of activity. Only editable if promotion is upcoming." }, "trigger" : { "$ref" : "#/components/schemas/PR04_Request_Trigger", "description" : "Trigger of the promotion" } } }, "PR04_Request_ApplicationToCart" : { "type" : "object", "description" : "If applicable, promo code associated to the promotion. Only editable if promotion is upcoming.", "properties" : { "promo_code" : { "type" : "string", "description" : "Promo code associated to the promotion" } } }, "PR04_Request_PublicDescriptions" : { "type" : "object", "description" : "The public descriptions of the promotion, with the locales they apply to", "properties" : { "locale" : { "type" : "string", "description" : "Description's locale" }, "value" : { "type" : "string", "description" : "The description itself" } } }, "PR04_Request_Reward" : { "type" : "object", "description" : "Defines the reward applied when promotion is triggered", "properties" : { "selection" : { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection", "description" : "The product assortment receiving the reward" } } }, "PR04_Request_Reward_Selection" : { "type" : "object", "description" : "The product assortment receiving the reward", "discriminator" : { "mapping" : { "BRAND" : "#/components/schemas/PR04_Request_Reward_Selection_Brand", "CATEGORY" : "#/components/schemas/PR04_Request_Reward_Selection_Category", "OFFER" : "#/components/schemas/PR04_Request_Reward_Selection_Offer", "PRODUCT" : "#/components/schemas/PR04_Request_Reward_Selection_Product", "PURCHASED_ITEMS" : "#/components/schemas/PR04_Request_Reward_Selection_PurchasedItems" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "The type of assortment selection for the reward" } } }, "PR04_Request_Reward_Selection_Brand" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR04_Request_Reward_Selection_Category" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR04_Request_Reward_Selection_Offer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR04_Request_Reward_Selection_Product" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection_Product_Values" } } } }, "PR04_Request_Reward_Selection_Product_Values" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Reference type (e.g., SKU, EAN, UPC)" }, "value" : { "type" : "string", "description" : "Reference value" } } }, "PR04_Request_Reward_Selection_PurchasedItems" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Reward_Selection" } ] }, "PR04_Request_Trigger" : { "type" : "object", "description" : "Trigger of the promotion", "properties" : { "selection" : { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection", "description" : "The product assortment triggering the promotion" } } }, "PR04_Request_Trigger_Selection" : { "type" : "object", "description" : "The product assortment triggering the promotion", "discriminator" : { "mapping" : { "ALL" : "#/components/schemas/PR04_Request_Trigger_Selection_All", "BRAND" : "#/components/schemas/PR04_Request_Trigger_Selection_Brand", "CATEGORY" : "#/components/schemas/PR04_Request_Trigger_Selection_Category", "OFFER" : "#/components/schemas/PR04_Request_Trigger_Selection_Offer", "PRODUCT" : "#/components/schemas/PR04_Request_Trigger_Selection_Product" }, "propertyName" : "type" }, "properties" : { "type" : { "type" : "string", "description" : "The type of assortment selection for the trigger" } } }, "PR04_Request_Trigger_Selection_All" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection" } ] }, "PR04_Request_Trigger_Selection_Brand" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR04_Request_Trigger_Selection_Category" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR04_Request_Trigger_Selection_Offer" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "type" : "string" } } } }, "PR04_Request_Trigger_Selection_Product" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection" } ], "properties" : { "values" : { "type" : "array", "description" : "The list of values corresponding to the assortment selection.", "items" : { "$ref" : "#/components/schemas/PR04_Request_Trigger_Selection_Product_Values" } } } }, "PR04_Request_Trigger_Selection_Product_Values" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Reference type (e.g., SKU, EAN, UPC)" }, "value" : { "type" : "string", "description" : "Reference value" } } }, "PRI01_Response_201" : { "type" : "object", "properties" : { "import_id" : { "type" : "string", "description" : "Offer pricing import identifier" } } }, "PRI02_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/PRI02_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "PRI02_Response_200_Data" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Indicate if an error report exists" }, "import_id" : { "type" : "string", "description" : "Import ID" }, "lines_in_error" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in error" }, "lines_in_success" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in success" }, "offers_in_error" : { "type" : "integer", "format" : "int32", "description" : "Total count of offers in error" }, "offers_updated" : { "type" : "integer", "format" : "int32", "description" : "Total count of updated offers" }, "origin" : { "type" : "string", "description" : "Import origin" }, "reason_status" : { "type" : "string", "description" : "Import status reason" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "status" : { "type" : "string", "description" : "Import status" } } }, "RE01_Response_200" : { "type" : "object", "properties" : { "reasons" : { "type" : "array", "description" : "List of reasons detailed", "items" : { "$ref" : "#/components/schemas/RE01_Response_200_Reasons" } } } }, "RE01_Response_200_Reasons" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Reason code" }, "is_customer_right" : { "type" : "boolean", "description" : "Indicate if reason is enabled to the customer" }, "is_operator_right" : { "type" : "boolean", "description" : "Indicate if reason is enabled to the operator" }, "is_shop_right" : { "type" : "boolean", "description" : "Indicate if reason is enabled to the shop" }, "label" : { "type" : "string", "description" : "Reason label" }, "type" : { "type" : "string", "description" : "Type of the reason" } } }, "RO02_Response_200" : { "type" : "object", "properties" : { "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RO02_Response_200_Roles" } } } }, "RO02_Response_200_Roles" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "description" : { "type" : "string" } } }, "RT01_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Returns list", "items" : { "$ref" : "#/components/schemas/RT01_Request_Returns" }, "maxItems" : 200, "minItems" : 1 } } }, "RT01_Request_Returns" : { "type" : "object", "description" : "Returns list", "properties" : { "accepted" : { "type" : "boolean", "description" : "If true, the return is automatically accepted after its creation. If false, the return cannot be accepted automatically. If empty, the returns configuration is taken into account to set the value." }, "description" : { "type" : "string", "description" : "Description", "maxLength" : 2000, "minLength" : 0 }, "label_url" : { "type" : "string", "description" : "Label URL", "maxLength" : 2000, "minLength" : 1 }, "method_code" : { "type" : "string", "description" : "Return method code" }, "order_commercial_id" : { "type" : "string", "description" : "Order commercial id" }, "reason_code" : { "type" : "string", "description" : "Return reason code" }, "return_lines" : { "type" : "array", "description" : "Return lines", "items" : { "$ref" : "#/components/schemas/RT01_Request_Returns_ReturnLines" }, "maxItems" : 200, "minItems" : 1 }, "rma" : { "type" : "string", "description" : "Return RMA", "maxLength" : 100, "minLength" : 1, "pattern" : "[0-9a-zA-Z_-]+" } } }, "RT01_Request_Returns_ReturnLines" : { "type" : "object", "description" : "Return lines", "properties" : { "order_line_id" : { "type" : "string", "description" : "Return order line id" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity to return", "minimum" : 1 }, "reason_code" : { "type" : "string", "description" : "Return reason code." } } }, "RT01_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Return creation errors", "items" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Return creation success", "items" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess" } } } }, "RT01_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Return creation error message" }, "order_commercial_id" : { "type" : "string", "description" : "Order commercial id of failed return creations" } } }, "RT01_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Return creation date" }, "description" : { "type" : "string", "description" : "Description" }, "documents" : { "type" : "array", "description" : "Return documents", "items" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_Documents" } }, "id" : { "type" : "string", "description" : "Return id" }, "label_url" : { "type" : "string", "description" : "Label URL" }, "last_updated" : { "type" : "string", "format" : "date-time", "description" : "Return last updated date" }, "method_code" : { "type" : "string", "description" : "Return method code" }, "order_commercial_id" : { "type" : "string", "description" : "Order commercial id" }, "order_id" : { "type" : "string", "description" : "Order id" }, "reason_code" : { "type" : "string", "description" : "Return reason code" }, "rejection_reason_code" : { "type" : "string", "description" : "Return rejection reason code" }, "return_address" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_ReturnAddress", "description" : "The address where items must be returned" }, "return_lines" : { "type" : "array", "description" : "Return lines", "items" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_ReturnLines" } }, "rma" : { "type" : "string", "description" : "Return RMA" }, "state" : { "type" : "string", "description" : "Return state" }, "tracking" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_Tracking", "description" : "Return tracking details" } } }, "RT01_Response_200_ReturnSuccess_Documents" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Return document id" }, "type" : { "type" : "string", "description" : "Return document type" } } }, "RT01_Response_200_ReturnSuccess_ReturnAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street1" : { "type" : "string", "description" : "First line of the return address" }, "street2" : { "type" : "string", "description" : "Second line of the return address" }, "zip_code" : { "type" : "string", "description" : "Zip code" } } }, "RT01_Response_200_ReturnSuccess_ReturnLines" : { "type" : "object", "properties" : { "compliance" : { "type" : "array", "description" : "Compliance", "items" : { "$ref" : "#/components/schemas/RT01_Response_200_ReturnSuccess_ReturnLines_Compliance" } }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity" }, "reason_code" : { "type" : "string", "description" : "Return reason code for this line." } } }, "RT01_Response_200_ReturnSuccess_ReturnLines_Compliance" : { "type" : "object", "properties" : { "compliant" : { "type" : "boolean", "description" : "Compliant" }, "non_compliance_additional_info" : { "type" : "string", "description" : "Non compliance additional info" }, "non_compliance_reason_code" : { "type" : "string", "description" : "Non compliance reason code" } } }, "RT01_Response_200_ReturnSuccess_Tracking" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "Carrier code" }, "carrier_name" : { "type" : "string", "description" : "Carrier name" }, "carrier_standard_code" : { "type" : "string", "description" : "Carrier standard code" }, "tracking_number" : { "type" : "string", "description" : "Tracking number" }, "tracking_url" : { "type" : "string", "description" : "Return tracking URL" } } }, "RT04_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Returns to be updated, maximum number of returns per call: 100", "items" : { "$ref" : "#/components/schemas/RT04_Request_Returns" }, "maxItems" : 100, "minItems" : 1 } } }, "RT04_Request_Returns" : { "type" : "object", "description" : "Returns to be updated, maximum number of returns per call: 100", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "label_url" : { "type" : "string", "description" : "Return label URL", "maxLength" : 2000 }, "method_code" : { "type" : "string", "description" : "Return method code. Can be provided only when the setting Allow store accounts to update the return method before acceptance is enabled." }, "return_address" : { "$ref" : "#/components/schemas/RT04_Request_Returns_ReturnAddress", "description" : "The address where items must be returned" }, "rma" : { "type" : "string", "description" : "Return RMA" }, "tracking" : { "$ref" : "#/components/schemas/RT04_Request_Returns_Tracking", "description" : "Tracking information" } } }, "RT04_Request_Returns_ReturnAddress" : { "type" : "object", "description" : "The address where items must be returned", "properties" : { "address" : { "$ref" : "#/components/schemas/RT04_Request_Returns_ReturnAddress_Address", "description" : "The return address details" } } }, "RT04_Request_Returns_ReturnAddress_Address" : { "type" : "object", "description" : "The return address details", "properties" : { "city" : { "type" : "string", "description" : "City", "maxLength" : 255, "minLength" : 0 }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State", "maxLength" : 255, "minLength" : 0 }, "street1" : { "type" : "string", "description" : "First line of the return address", "maxLength" : 255, "minLength" : 0 }, "street2" : { "type" : "string", "description" : "Second line of the return address", "maxLength" : 255, "minLength" : 0 }, "zip_code" : { "type" : "string", "description" : "Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay", "maxLength" : 255, "minLength" : 0 } } }, "RT04_Request_Returns_Tracking" : { "type" : "object", "description" : "Tracking information", "properties" : { "carrier_code" : { "type" : "string", "description" : "Carrier Code" }, "carrier_name" : { "type" : "string", "description" : "Carrier name" }, "carrier_standard_code" : { "type" : "string", "description" : "Carrier Standard Code" }, "tracking_number" : { "type" : "string", "description" : "Tracking number" }, "tracking_url" : { "type" : "string", "description" : "Url tracking", "maxLength" : 2000 } } }, "RT04_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Returns update errors", "items" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Returns update success", "items" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess" } } } }, "RT04_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "RT04_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Return creation date" }, "description" : { "type" : "string", "description" : "Description" }, "documents" : { "type" : "array", "description" : "Return documents", "items" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_Documents" } }, "id" : { "type" : "string", "description" : "Return id" }, "label_url" : { "type" : "string", "description" : "Label URL" }, "last_updated" : { "type" : "string", "format" : "date-time", "description" : "Return last updated date" }, "method_code" : { "type" : "string", "description" : "Return method code" }, "order_commercial_id" : { "type" : "string", "description" : "Order commercial id" }, "order_id" : { "type" : "string", "description" : "Order id" }, "reason_code" : { "type" : "string", "description" : "Return reason code" }, "rejection_reason_code" : { "type" : "string", "description" : "Return rejection reason code" }, "return_address" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_ReturnAddress", "description" : "The address where items must be returned" }, "return_lines" : { "type" : "array", "description" : "Return lines", "items" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_ReturnLines" } }, "rma" : { "type" : "string", "description" : "Return RMA" }, "state" : { "type" : "string", "description" : "Return state" }, "tracking" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_Tracking", "description" : "Return tracking details" } } }, "RT04_Response_200_ReturnSuccess_Documents" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Return document id" }, "type" : { "type" : "string", "description" : "Return document type" } } }, "RT04_Response_200_ReturnSuccess_ReturnAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street1" : { "type" : "string", "description" : "First line of the return address" }, "street2" : { "type" : "string", "description" : "Second line of the return address" }, "zip_code" : { "type" : "string", "description" : "Zip code" } } }, "RT04_Response_200_ReturnSuccess_ReturnLines" : { "type" : "object", "properties" : { "compliance" : { "type" : "array", "description" : "Compliance", "items" : { "$ref" : "#/components/schemas/RT04_Response_200_ReturnSuccess_ReturnLines_Compliance" } }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity" }, "reason_code" : { "type" : "string", "description" : "Return reason code for this line." } } }, "RT04_Response_200_ReturnSuccess_ReturnLines_Compliance" : { "type" : "object", "properties" : { "compliant" : { "type" : "boolean", "description" : "Compliant" }, "non_compliance_additional_info" : { "type" : "string", "description" : "Non compliance additional info" }, "non_compliance_reason_code" : { "type" : "string", "description" : "Non compliance reason code" } } }, "RT04_Response_200_ReturnSuccess_Tracking" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "Carrier code" }, "carrier_name" : { "type" : "string", "description" : "Carrier name" }, "carrier_standard_code" : { "type" : "string", "description" : "Carrier standard code" }, "tracking_number" : { "type" : "string", "description" : "Tracking number" }, "tracking_url" : { "type" : "string", "description" : "Return tracking URL" } } }, "RT11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/RT11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "RT11_Response_200_Data" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Return creation date" }, "description" : { "type" : "string", "description" : "Description" }, "documents" : { "type" : "array", "description" : "Return documents", "items" : { "$ref" : "#/components/schemas/RT11_Response_200_Data_Documents" } }, "id" : { "type" : "string", "description" : "Return id" }, "label_url" : { "type" : "string", "description" : "Label URL" }, "last_updated" : { "type" : "string", "format" : "date-time", "description" : "Return last updated date" }, "method_code" : { "type" : "string", "description" : "Return method code" }, "order_commercial_id" : { "type" : "string", "description" : "Order commercial id" }, "order_id" : { "type" : "string", "description" : "Order id" }, "reason_code" : { "type" : "string", "description" : "Return reason code" }, "rejection_reason_code" : { "type" : "string", "description" : "Return rejection reason code" }, "return_address" : { "$ref" : "#/components/schemas/RT11_Response_200_Data_ReturnAddress", "description" : "The address where items must be returned" }, "return_lines" : { "type" : "array", "description" : "Return lines", "items" : { "$ref" : "#/components/schemas/RT11_Response_200_Data_ReturnLines" } }, "rma" : { "type" : "string", "description" : "Return RMA" }, "state" : { "type" : "string", "description" : "Return state" }, "tracking" : { "$ref" : "#/components/schemas/RT11_Response_200_Data_Tracking", "description" : "Return tracking details" } } }, "RT11_Response_200_Data_Documents" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Return document id" }, "type" : { "type" : "string", "description" : "Return document type" } } }, "RT11_Response_200_Data_ReturnAddress" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street1" : { "type" : "string", "description" : "First line of the return address" }, "street2" : { "type" : "string", "description" : "Second line of the return address" }, "zip_code" : { "type" : "string", "description" : "Zip code" } } }, "RT11_Response_200_Data_ReturnLines" : { "type" : "object", "properties" : { "compliance" : { "type" : "array", "description" : "Compliance", "items" : { "$ref" : "#/components/schemas/RT11_Response_200_Data_ReturnLines_Compliance" } }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity" }, "reason_code" : { "type" : "string", "description" : "Return reason code for this line." } } }, "RT11_Response_200_Data_ReturnLines_Compliance" : { "type" : "object", "properties" : { "compliant" : { "type" : "boolean", "description" : "Compliant" }, "non_compliance_additional_info" : { "type" : "string", "description" : "Non compliance additional info" }, "non_compliance_reason_code" : { "type" : "string", "description" : "Non compliance reason code" } } }, "RT11_Response_200_Data_Tracking" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "Carrier code" }, "carrier_name" : { "type" : "string", "description" : "Carrier name" }, "carrier_standard_code" : { "type" : "string", "description" : "Carrier standard code" }, "tracking_number" : { "type" : "string", "description" : "Tracking number" }, "tracking_url" : { "type" : "string", "description" : "Return tracking URL" } } }, "RT12_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/RT12_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "RT12_Response_200_Data" : { "type" : "object", "properties" : { "available_return_methods" : { "type" : "array", "description" : "Available return methods to return items", "items" : { "type" : "string" } }, "available_return_reasons" : { "type" : "array", "description" : "Available return reasons to return items", "items" : { "type" : "string" } }, "order_commercial_id" : { "type" : "string", "description" : "Order commercial id" }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "return_window" : { "type" : "integer", "format" : "int32", "description" : "Items must be returned during the return window" }, "return_window_end_date" : { "type" : "string", "format" : "date-time", "description" : "Return window end date for the items of the order line" }, "return_window_start_date" : { "type" : "string", "format" : "date-time", "description" : "Return window start date for the items of the order line" }, "returnable_quantity" : { "type" : "integer", "format" : "int64", "description" : "Item quantity available to be returned" } } }, "RT21_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Returns to be accepted, maximum number of returns per call: 100", "items" : { "$ref" : "#/components/schemas/RT21_Request_Returns" }, "maxItems" : 100, "minItems" : 1 } } }, "RT21_Request_Returns" : { "type" : "object", "description" : "Returns to be accepted, maximum number of returns per call: 100", "properties" : { "accepted" : { "type" : "boolean", "description" : "Boolean indicating if the return is accepted or refused" }, "id" : { "type" : "string", "description" : "Return id" }, "rejection_reason_code" : { "type" : "string", "description" : "Return rejection reason code" } } }, "RT21_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Returns update errors", "items" : { "$ref" : "#/components/schemas/RT21_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Returns update success", "items" : { "$ref" : "#/components/schemas/RT21_Response_200_ReturnSuccess" } } } }, "RT21_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "RT21_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT25_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Return ids", "items" : { "$ref" : "#/components/schemas/RT25_Request_Returns" }, "maxItems" : 100, "minItems" : 1 } } }, "RT25_Request_Returns" : { "type" : "object", "description" : "Return ids", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT25_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Returns update errors", "items" : { "$ref" : "#/components/schemas/RT25_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Returns update success", "items" : { "$ref" : "#/components/schemas/RT25_Response_200_ReturnSuccess" } } } }, "RT25_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "RT25_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT26_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Mark returns as compliant or non-compliant, maximum number of returns per call: 100", "items" : { "$ref" : "#/components/schemas/RT26_Request_Returns" }, "maxItems" : 100, "minItems" : 1 } } }, "RT26_Request_Returns" : { "type" : "object", "description" : "Mark returns as compliant or non-compliant, maximum number of returns per call: 100", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "return_lines" : { "type" : "array", "description" : "Return lines", "items" : { "$ref" : "#/components/schemas/RT26_Request_Returns_ReturnLines" }, "maxItems" : 200, "minItems" : 1 } } }, "RT26_Request_Returns_ReturnLines" : { "type" : "object", "description" : "Return lines", "properties" : { "compliant" : { "type" : "boolean", "description" : "Compliant" }, "non_compliance_additional_info" : { "type" : "string", "description" : "Non-compliance additional information", "maxLength" : 2000, "minLength" : 0 }, "non_compliance_reason_code" : { "type" : "string", "description" : "Non-compliance reason code" }, "order_line_id" : { "type" : "string", "description" : "Order line id" } } }, "RT26_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Returns update errors", "items" : { "$ref" : "#/components/schemas/RT26_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Returns update success", "items" : { "$ref" : "#/components/schemas/RT26_Response_200_ReturnSuccess" } } } }, "RT26_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "RT26_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT27_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Return ids", "items" : { "$ref" : "#/components/schemas/RT27_Request_Returns" }, "maxItems" : 100, "minItems" : 1 } } }, "RT27_Request_Returns" : { "type" : "object", "description" : "Return ids", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT27_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Returns update errors", "items" : { "$ref" : "#/components/schemas/RT27_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Returns update success", "items" : { "$ref" : "#/components/schemas/RT27_Response_200_ReturnSuccess" } } } }, "RT27_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "RT27_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT29_Request" : { "type" : "object", "properties" : { "returns" : { "type" : "array", "description" : "Return ids", "items" : { "$ref" : "#/components/schemas/RT29_Request_Returns" }, "maxItems" : 100, "minItems" : 1 } } }, "RT29_Request_Returns" : { "type" : "object", "description" : "Return ids", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT29_Response_200" : { "type" : "object", "properties" : { "return_errors" : { "type" : "array", "description" : "Returns update errors", "items" : { "$ref" : "#/components/schemas/RT29_Response_200_ReturnErrors" } }, "return_success" : { "type" : "array", "description" : "Returns update success", "items" : { "$ref" : "#/components/schemas/RT29_Response_200_ReturnSuccess" } } } }, "RT29_Response_200_ReturnErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "RT29_Response_200_ReturnSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Return id, must be a valid UUID", "maxLength" : 36, "minLength" : 0 } } }, "RT51_Request" : { "type" : "object", "properties" : { "return_labels" : { "type" : "array", "description" : "Returns list", "items" : { "$ref" : "#/components/schemas/RT51_Request_ReturnLabels" }, "maxItems" : 200, "minItems" : 0 } } }, "RT51_Request_ReturnLabels" : { "type" : "object", "description" : "Returns list", "properties" : { "carrier_code" : { "type" : "string", "description" : "Carrier code to be used to generate the label. Required if no label_selection_mode is provided." }, "carrier_service_code" : { "type" : "string", "description" : "Specific code of the service to be used for a given carrier. If not provided, the default service of the carrier will be used. carrier_code needs to be provided in order to use this field." }, "label_options" : { "$ref" : "#/components/schemas/RT51_Request_ReturnLabels_LabelOptions", "description" : "Specific options applying on label generation" }, "label_selection_mode" : { "type" : "string", "description" : "Indicate whether an automatic selection of a label should be made. Required if no carrier_code is provided. If no carrier code is provided, the requested option from all connected carriers will be selected. If a carrier code is provided, the requested option for the specified carrier will be selected." }, "package" : { "$ref" : "#/components/schemas/RT51_Request_ReturnLabels_Package", "description" : "Details of the package containing the returned items" }, "return_id" : { "type" : "string", "description" : "Return ID" }, "shipping_from" : { "$ref" : "#/components/schemas/RT51_Request_ReturnLabels_ShippingFrom", "description" : "Custom pickup address for the return (e.g. store address for in-store returns). If not provided, the initial shipping address of the related order will be used." } } }, "RT51_Request_ReturnLabels_LabelOptions" : { "type" : "object", "description" : "Specific options applying on label generation", "properties" : { "qr_code" : { "type" : "boolean", "description" : "Whether to generate a QR code alongside the PDF label. Default false" } } }, "RT51_Request_ReturnLabels_Package" : { "type" : "object", "description" : "Details of the package containing the returned items", "properties" : { "dimensions" : { "$ref" : "#/components/schemas/RT51_Request_ReturnLabels_Package_Dimensions", "description" : "Physical dimensions of the package" }, "weight" : { "$ref" : "#/components/schemas/RT51_Request_ReturnLabels_Package_Weight", "description" : "Weight of the package" } } }, "RT51_Request_ReturnLabels_Package_Dimensions" : { "type" : "object", "description" : "Physical dimensions of the package", "properties" : { "height" : { "type" : "number", "description" : "package height", "minimum" : 0 }, "length" : { "type" : "number", "description" : "package length", "minimum" : 0 }, "unit" : { "type" : "string", "description" : "Dimension unit", "pattern" : "^(in|cm)$" }, "width" : { "type" : "number", "description" : "package width", "minimum" : 0 } } }, "RT51_Request_ReturnLabels_Package_Weight" : { "type" : "object", "description" : "Weight of the package", "properties" : { "unit" : { "type" : "string", "description" : "Weight unit", "pattern" : "^(lb|kg)$" }, "value" : { "type" : "number", "description" : "Numeric weight value", "minimum" : 0 } } }, "RT51_Request_ReturnLabels_ShippingFrom" : { "type" : "object", "description" : "Custom pickup address for the return (e.g. store address for in-store returns). If not provided, the initial shipping address of the related order will be used.", "properties" : { "city" : { "type" : "string", "description" : "City" }, "contact_name" : { "type" : "string", "description" : "Contact name" }, "contact_phone" : { "type" : "string", "description" : "Contact phone" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street_1" : { "type" : "string", "description" : "First line of the address" }, "street_2" : { "type" : "string", "description" : "Second line of the address" }, "zip_code" : { "type" : "string", "description" : "Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay" } } }, "RT51_Response_200" : { "type" : "object", "properties" : { "return_label_errors" : { "type" : "array", "description" : "Returns for which label creation failed, with per-item error messages", "items" : { "$ref" : "#/components/schemas/RT51_Response_200_ReturnLabelErrors" } }, "return_label_successes" : { "type" : "array", "description" : "Returns for which a label was successfully created", "items" : { "$ref" : "#/components/schemas/RT51_Response_200_ReturnLabelSuccesses" } } } }, "RT51_Response_200_ReturnLabelErrors" : { "type" : "object", "properties" : { "error_message" : { "type" : "string", "description" : "Error description" }, "return_id" : { "type" : "string", "description" : "Return ID" } } }, "RT51_Response_200_ReturnLabelSuccesses" : { "type" : "object", "properties" : { "return_id" : { "type" : "string", "description" : "Return ID" } } }, "RT52_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/RT52_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "RT52_Response_200_Data" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Return label creation date" }, "errors" : { "type" : "array", "description" : "Specific information related to the state of the label. Available only when label_state is FAILED", "items" : { "$ref" : "#/components/schemas/RT52_Response_200_Data_Errors" } }, "estimated_cost" : { "$ref" : "#/components/schemas/RT52_Response_200_Data_EstimatedCost", "description" : "Estimated cost of the label from the carrier" }, "files" : { "$ref" : "#/components/schemas/RT52_Response_200_Data_Files", "description" : "Container for label file(s)" }, "label_state" : { "type" : "string", "description" : "Current state of the label" }, "last_updated" : { "type" : "string", "format" : "date-time", "description" : "Return label last updated date" }, "return_id" : { "type" : "string", "description" : "Return ID" }, "tracking" : { "$ref" : "#/components/schemas/RT52_Response_200_Data_Tracking", "description" : "Return label tracking details" } } }, "RT52_Response_200_Data_Errors" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Code of the error" }, "message" : { "type" : "string", "description" : "Message of the error" } } }, "RT52_Response_200_Data_EstimatedCost" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "description" : "Label cost amount" }, "currency_iso_code" : { "type" : "string", "description" : "Label currency (iso format)" } } }, "RT52_Response_200_Data_Files" : { "type" : "object", "properties" : { "label" : { "$ref" : "#/components/schemas/RT52_Response_200_Data_Files_Label", "description" : "Label file" }, "qr_code" : { "$ref" : "#/components/schemas/RT52_Response_200_Data_Files_QrCode", "description" : "QR code file" } } }, "RT52_Response_200_Data_Files_Label" : { "type" : "object", "properties" : { "file_type" : { "type" : "string", "description" : "File format" }, "url" : { "type" : "string", "description" : "Download URL" } } }, "RT52_Response_200_Data_Files_QrCode" : { "type" : "object", "properties" : { "file_type" : { "type" : "string", "description" : "File format" }, "url" : { "type" : "string", "description" : "Download URL" } } }, "RT52_Response_200_Data_Tracking" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "Code of a carrier" }, "carrier_name" : { "type" : "string", "description" : "Name of a carrier" }, "carrier_service_code" : { "type" : "string", "description" : "Carrier’s service code used to generate the label" }, "carrier_standard_code" : { "type" : "string", "description" : "Standard code of a carrier based on Mirakl carrier referential" }, "tracking_number" : { "type" : "string", "description" : "Tracking number" }, "tracking_url" : { "type" : "string", "description" : "Tracking url of a carrier" } } }, "S30_Response_200" : { "type" : "object", "properties" : { "shop_documents" : { "type" : "array", "description" : "The document details", "items" : { "$ref" : "#/components/schemas/S30_Response_200_ShopDocuments" } } } }, "S30_Response_200_ShopDocuments" : { "type" : "object", "properties" : { "date_deleted" : { "type" : "string", "format" : "date-time", "description" : "Document deleted date" }, "date_uploaded" : { "type" : "string", "format" : "date-time", "description" : "Document uploaded date" }, "file_name" : { "type" : "string", "description" : "Document file name" }, "id" : { "type" : "integer", "format" : "int64", "description" : "Document identifier" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "The id of the shop owning the document" }, "type" : { "type" : "string", "description" : "Document type code" } } }, "SBC11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "SBC11_Response_200_Data" : { "type" : "object", "properties" : { "amount_transferred_to_operator" : { "type" : "number", "description" : "Total amount to be transferred to the operator" }, "amount_transferred_to_seller" : { "type" : "number", "description" : "Total amount to be transferred to the seller" }, "currency_iso_code" : { "type" : "string", "description" : "The currency of the shop" }, "date_created" : { "type" : "string", "format" : "date-time", "description" : "Seller billing cycle creation date" }, "id" : { "type" : "string", "description" : "Seller billing cycle identifier" }, "pay_out" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data_PayOut", "description" : "Pay-out details" }, "pay_out_psp_code" : { "type" : "string", "description" : "PSP code for Pay-out" }, "payment_voucher_number" : { "type" : "string", "description" : "The payment voucher number" }, "shop" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data_Shop", "description" : "Shop information" }, "summary" : { "$ref" : "#/components/schemas/SBC11_Response_200_Data_Summary", "description" : "Financial summary of the billing cycle" } } }, "SBC11_Response_200_Data_PayOut" : { "type" : "object", "properties" : { "failure_reason" : { "type" : "string", "description" : "Pay-out failure reason, present only when state is FAILED" }, "reference" : { "type" : "string", "description" : "Pay-out reference, present only when state is PAID" }, "state" : { "type" : "string", "description" : "Pay-out state" }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Pay-out transaction date, present only when state is PAID" } } }, "SBC11_Response_200_Data_Shop" : { "type" : "object", "properties" : { "shop_corporate_name" : { "type" : "string", "description" : "Shop corporate name" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "shop_model" : { "type" : "string", "description" : "Shop model" }, "shop_name" : { "type" : "string", "description" : "Shop name" }, "shop_operator_internal_id" : { "type" : "string", "description" : "Operator internal id for the shop" } } }, "SBC11_Response_200_Data_Summary" : { "type" : "object", "properties" : { "total_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of commissions (excluding taxes on orders)" }, "total_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of commissions (including taxes on orders)" }, "total_fee_excl_tax" : { "type" : "number", "description" : "Total amount of fees (excluding taxes on orders)" }, "total_fee_incl_tax" : { "type" : "number", "description" : "Total amount of fees (including taxes on orders)" }, "total_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (excluding taxes on orders)" }, "total_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of fees remitted by the operator (including taxes on orders)" }, "total_mirakl_ads_credit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_credit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads credits of a payment cycle (including taxes on stores)" }, "total_mirakl_ads_debit_excl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (excluding taxes on stores)" }, "total_mirakl_ads_debit_incl_tax" : { "type" : "number", "description" : "Total amount for Mirakl Ads debits of a payment cycle (including taxes on stores)" }, "total_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for non payable orders (including shipping charges and taxes on orders)" }, "total_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (excluding taxes on orders)" }, "total_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of shipping charges paid by the operator (including taxes on orders)" }, "total_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount for order taxes remitted by the operator" }, "total_other_credits_excl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (excluding taxes on stores)" }, "total_other_credits_incl_tax" : { "type" : "number", "description" : "Total amount for other manual credits of a payment cycle (including taxes on stores)" }, "total_other_invoices_excl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (excluding taxes on stores)" }, "total_other_invoices_incl_tax" : { "type" : "number", "description" : "Total amount for other manual invoices of a payment cycle (including taxes on stores)" }, "total_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount for payable orders including shipping charges (excluding taxes on orders)" }, "total_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount for payable orders including taxes (including taxes on orders)" }, "total_purchase_taxes" : { "type" : "number", "description" : "Total amount for purchase taxes" }, "total_refund_commissions_excl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (excluding taxes on orders)" }, "total_refund_commissions_incl_tax" : { "type" : "number", "description" : "Total amount of refunded commissions (including taxes on orders)" }, "total_refund_fee_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (excluding taxes on orders)" }, "total_refund_fee_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees (including taxes on orders)" }, "total_refund_fee_operator_remitted_excl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (excluding taxes on orders)" }, "total_refund_fee_operator_remitted_incl_tax" : { "type" : "number", "description" : "Total amount of refunded fees remitted by the operator (including taxes on orders)" }, "total_refund_non_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (including shipping charges and excluding taxes on orders)" }, "total_refund_non_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for non payable orders (excluding shipping charges and including taxes on orders)" }, "total_refund_operator_paid_shipping_charges_excl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (excluding taxes on orders)" }, "total_refund_operator_paid_shipping_charges_incl_tax" : { "type" : "number", "description" : "Total amount of refunded shipping charges paid by the operator (including taxes on orders)" }, "total_refund_operator_remitted_taxes" : { "type" : "number", "description" : "Total amount of refunded taxes remitted by the operator" }, "total_refund_orders_excl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (excluding all refunded taxes)" }, "total_refund_orders_incl_tax" : { "type" : "number", "description" : "Total amount of refunded orders (including all refunded taxes)" }, "total_refund_payable_orders_excl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (excluding taxes on orders)" }, "total_refund_payable_orders_incl_tax" : { "type" : "number", "description" : "Total amount refunded for payable orders (including taxes on orders)" }, "total_refund_purchase_taxes" : { "type" : "number", "description" : "Total amount of refunded purchase taxes" }, "total_seller_fees_on_orders_excl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (excluding taxes on orders)" }, "total_seller_fees_on_orders_incl_tax" : { "type" : "number", "description" : "Total amount of seller fees on orders (including taxes on orders)" }, "total_seller_penalty_fees_excl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (excluding taxes on orders)" }, "total_seller_penalty_fees_incl_tax" : { "type" : "number", "description" : "Total amount of seller penalty fees (including taxes on orders)" }, "total_subscription_excl_tax" : { "type" : "number", "description" : "Total amount of subscription fees (excluding taxes on stores)" }, "total_subscription_incl_tax" : { "type" : "number", "description" : "Total amount of subscription taxes (including taxes on stores)" } } }, "SH11_Response_200" : { "type" : "object", "properties" : { "shipping_zones" : { "type" : "array", "description" : "List of shipping zones", "items" : { "$ref" : "#/components/schemas/SH11_Response_200_ShippingZones" } } } }, "SH11_Response_200_ShippingZones" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Shipping zone code" }, "description" : { "type" : "string", "description" : "Shipping zone description" }, "label" : { "type" : "string", "description" : "Shipping zone label" } } }, "SH12_Response_200" : { "type" : "object", "properties" : { "shipping_types" : { "type" : "array", "description" : "List of shipping types", "items" : { "$ref" : "#/components/schemas/SH12_Response_200_ShippingTypes" } } } }, "SH12_Response_200_ShippingTypes" : { "type" : "object", "properties" : { "click_and_collect" : { "type" : "boolean", "description" : "Shipping type corresponds to “click&collect”" }, "code" : { "type" : "string", "description" : "Shipping type code" }, "delivery_by_operator" : { "type" : "boolean", "description" : "Shipping type is managed by operator on behalf of shops" }, "description" : { "type" : "string", "description" : "Shipping type description" }, "ignore_lead_time_to_ship" : { "type" : "boolean", "description" : "When true, the lead time to ship is ignored for shipping deadline computation" }, "label" : { "type" : "string", "description" : "Shipping type label" }, "mandatory_tracking" : { "type" : "boolean", "description" : "Shops must provide tracking details before confirming shipment for a given shipping type" }, "standard_code" : { "type" : "string", "description" : "Shipping type standard code" } } }, "SH21_Response_200" : { "type" : "object", "properties" : { "carriers" : { "type" : "array", "description" : "List of carriers", "items" : { "$ref" : "#/components/schemas/SH21_Response_200_Carriers" } } } }, "SH21_Response_200_Carriers" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Carrier code" }, "label" : { "type" : "string", "description" : "Carrier label" }, "standard_code" : { "type" : "string", "description" : "Carrier standard code" }, "tracking_url" : { "type" : "string", "description" : "Carrier tracking URL" } } }, "SH31_Response_200" : { "type" : "object", "properties" : { "logistic_classes" : { "type" : "array", "description" : "List of logistic classes", "items" : { "$ref" : "#/components/schemas/SH31_Response_200_LogisticClasses" } } } }, "SH31_Response_200_LogisticClasses" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Logistic class code" }, "description" : { "type" : "string", "description" : "Logistic class description" }, "label" : { "type" : "string", "description" : "Logistic class label" } } }, "ST01_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "Shipments list", "items" : { "$ref" : "#/components/schemas/ST01_Request_Shipments" }, "maxItems" : 1000, "minItems" : 1 } } }, "ST01_Request_Shipments" : { "type" : "object", "description" : "Shipments list", "properties" : { "invoice_reference" : { "type" : "string", "description" : "Shipment's invoice reference", "maxLength" : 255, "minLength" : 0, "pattern" : "[0-9a-zA-Z_-]*" }, "order_id" : { "type" : "string", "description" : "Order identifier", "maxLength" : 2147483647, "minLength" : 1 }, "shipment_additional_information" : { "type" : "array", "description" : "Shipment's additional information", "items" : { "$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation" } }, "shipment_lines" : { "type" : "array", "description" : "Shipment lines", "items" : { "$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentLines" }, "maxItems" : 2147483647, "minItems" : 1 }, "shipped" : { "type" : "boolean", "default" : false, "description" : "If true, the shipment is shipped after its creation" }, "shipping_from" : { "$ref" : "#/components/schemas/ST01_Request_Shipments_ShippingFrom", "description" : "Shipment's shipping origin" }, "tracking" : { "$ref" : "#/components/schemas/ST01_Request_Shipments_Tracking", "description" : "Shipment tracking details" } } }, "ST01_Request_Shipments_ShipmentAdditionalInformation" : { "type" : "object", "description" : "Shipment's additional information", "discriminator" : { "mapping" : { "DATE" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation_Date", "STRING" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation_String" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "The code associated to shipment additional information that you want to complete" }, "type" : { "type" : "string", "description" : "The type associated to the shipment additional information that you want to complete" }, "value" : { "type" : "object", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST01_Request_Shipments_ShipmentAdditionalInformation_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST01_Request_Shipments_ShipmentAdditionalInformation_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST01_Request_Shipments_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST01_Request_Shipments_ShipmentLines" : { "type" : "object", "description" : "Shipment lines", "properties" : { "offer_sku" : { "type" : "string", "deprecated" : true, "description" : "Offer sku" }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "package_reference" : { "type" : "string", "description" : "Package reference" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity", "minimum" : 1 } } }, "ST01_Request_Shipments_ShippingFrom" : { "type" : "object", "description" : "Shipment's shipping origin", "properties" : { "warehouse" : { "$ref" : "#/components/schemas/ST01_Request_Shipments_ShippingFrom_Warehouse", "description" : "The warehouse from where the shipment is shipped" } } }, "ST01_Request_Shipments_ShippingFrom_Warehouse" : { "type" : "object", "description" : "The warehouse from where the shipment is shipped", "properties" : { "code" : { "type" : "string", "description" : "The code of the warehouse" } } }, "ST01_Request_Shipments_Tracking" : { "type" : "object", "description" : "Shipment tracking details", "properties" : { "carrier_code" : { "type" : "string", "description" : "The code of a carrier. This information is mandatory for a registered carrier." }, "carrier_name" : { "type" : "string", "description" : "The name of a carrier. This information is mandatory for an unregistered carrier." }, "carrier_standard_code" : { "type" : "string", "description" : "The standard code of a carrier based on mirakl carrier referential" }, "tracking_number" : { "type" : "string", "description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number." }, "tracking_url" : { "type" : "string", "description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.\n" } } }, "ST01_Response_201" : { "type" : "object", "properties" : { "shipment_errors" : { "type" : "array", "description" : "Shipment creation errors", "items" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentErrors" } }, "shipment_success" : { "type" : "array", "description" : "Shipment creation success", "items" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess" } } } }, "ST01_Response_201_ShipmentErrors" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Shipment error creation message" }, "order_id" : { "type" : "string", "description" : "Order id of the shipment creation error" } } }, "ST01_Response_201_ShipmentSuccess" : { "type" : "object", "properties" : { "created_date" : { "type" : "string", "format" : "date-time", "description" : "Shipment's creation date" }, "id" : { "type" : "string", "description" : "Shipment id" }, "invoice_reference" : { "type" : "string", "description" : "Shipment's invoice reference" }, "last_updated_date" : { "type" : "string", "format" : "date-time", "description" : "Shipment's last updated date" }, "order_id" : { "type" : "string", "description" : "Order id" }, "payment_details" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_PaymentDetails", "description" : "Shipment's payment details" }, "shipment_additional_information" : { "type" : "array", "description" : "Shipment's additional information", "items" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation" } }, "shipment_lines" : { "type" : "array", "description" : "Shipment lines", "items" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentLines" } }, "shipped_date" : { "type" : "string", "format" : "date-time", "description" : "Shipment's shipped date." }, "shipping_from" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShippingFrom", "description" : "Shipment's shipping origin" }, "status" : { "type" : "string", "description" : "Shipment status" }, "status_customer_debit" : { "type" : "string", "description" : "Shipment debit status" }, "tracking" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking", "description" : "Shipment tracking details" } } }, "ST01_Response_201_ShipmentSuccess_PaymentDetails" : { "type" : "object", "properties" : { "customer_debited_date" : { "type" : "string", "format" : "date-time", "description" : "Payment's date of the shipment by the customer" }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Payment transaction date" }, "transaction_number" : { "type" : "string", "description" : "Payment transaction number" } } }, "ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation" : { "type" : "object", "discriminator" : { "mapping" : { "DATE" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_Date", "STRING" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_String" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Shipment's additional information code" }, "type" : { "type" : "string", "description" : "Shipment's additional information type" } } }, "ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "Shipment's additional information value" } } }, "ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "Shipment's additional information value" } } }, "ST01_Response_201_ShipmentSuccess_ShipmentLines" : { "type" : "object", "properties" : { "offer_sku" : { "type" : "string", "deprecated" : true, "description" : "Offer sku" }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "package_reference" : { "type" : "string", "description" : "Package reference" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity", "minimum" : 1 } } }, "ST01_Response_201_ShipmentSuccess_ShippingFrom" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShippingFrom_Address", "description" : "Shipping origin address" }, "warehouse" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_ShippingFrom_Warehouse", "description" : "Shipping origin warehouse" } } }, "ST01_Response_201_ShipmentSuccess_ShippingFrom_Address" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "ST01_Response_201_ShipmentSuccess_ShippingFrom_Warehouse" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Warehouse's code" } } }, "ST01_Response_201_ShipmentSuccess_Tracking" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "The code of a carrier. This information is mandatory for a registered carrier." }, "carrier_expected_delivery_date" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate" }, "carrier_name" : { "type" : "string", "description" : "The name of a carrier. This information is mandatory for an unregistered carrier." }, "carrier_standard_code" : { "type" : "string", "description" : "The standard code of a carrier based on mirakl carrier referential" }, "last_known_location" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation", "description" : "The last location known and transmitted by carriers" }, "milestones" : { "type" : "array", "description" : "Retrieves the main stages of the delivery of a shipment coming from carrier's systems", "items" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones" } }, "tracking_number" : { "type" : "string", "description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number." }, "tracking_url" : { "type" : "string", "description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers." }, "validity_status" : { "type" : "string", "description" : "Retrieves if mirakl is able to get tracking information (if not, then unverified) and if we manage to get tracking information and if we do get tracking information on this tracking, then it moves to verified, if we don't it remains in unverified" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate" : { "type" : "object", "properties" : { "earliest" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Earliest" }, "latest" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Latest" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Earliest" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Latest" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation" : { "type" : "object", "properties" : { "location" : { "type" : "string", "description" : "Last known location of the shipment" }, "occurrence_date" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation_OccurrenceDate", "description" : "Occurrence date of the known location" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation_OccurrenceDate" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_Milestones" : { "type" : "object", "properties" : { "additional_info" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo", "description" : "Additional information about the current milestone" }, "occurrence_date" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones_OccurrenceDate", "description" : "Occurrence date" }, "type" : { "type" : "string", "description" : "Type of milestone" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo" : { "type" : "object", "properties" : { "occurrence_date" : { "$ref" : "#/components/schemas/ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo_OccurrenceDate", "description" : "Occurrence date" }, "type" : { "type" : "string", "description" : "Type of the additional information" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo_OccurrenceDate" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST01_Response_201_ShipmentSuccess_Tracking_Milestones_OccurrenceDate" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST06_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "Shipment ids", "items" : { "$ref" : "#/components/schemas/ST06_Request_Shipments" }, "maxItems" : 1000, "minItems" : 1 } } }, "ST06_Request_Shipments" : { "type" : "object", "description" : "Shipment ids", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST06_Response_200" : { "type" : "object", "properties" : { "shipment_errors" : { "type" : "array", "description" : "Shipment workflow update errors", "items" : { "$ref" : "#/components/schemas/ST06_Response_200_ShipmentErrors" } }, "shipment_success" : { "type" : "array", "description" : "Shipment workflow update success", "items" : { "$ref" : "#/components/schemas/ST06_Response_200_ShipmentSuccess" } } } }, "ST06_Response_200_ShipmentErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "ST06_Response_200_ShipmentSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST07_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "Shipments list", "items" : { "$ref" : "#/components/schemas/ST07_Request_Shipments" }, "maxItems" : 100, "minItems" : 1 } } }, "ST07_Request_Shipments" : { "type" : "object", "description" : "Shipments list", "properties" : { "id" : { "type" : "string", "description" : "The shipment id" }, "shipping_from" : { "$ref" : "#/components/schemas/ST07_Request_Shipments_ShippingFrom", "description" : "Shipment's shipping origin" } } }, "ST07_Request_Shipments_ShippingFrom" : { "type" : "object", "description" : "Shipment's shipping origin", "properties" : { "warehouse" : { "$ref" : "#/components/schemas/ST07_Request_Shipments_ShippingFrom_Warehouse", "description" : "The warehouse from where the shipment is shipped" } } }, "ST07_Request_Shipments_ShippingFrom_Warehouse" : { "type" : "object", "description" : "The warehouse from where the shipment is shipped", "properties" : { "code" : { "type" : "string", "description" : "The code of the warehouse" } } }, "ST07_Response_200" : { "type" : "object", "properties" : { "shipment_errors" : { "type" : "array", "description" : "Shipment update errors", "items" : { "$ref" : "#/components/schemas/ST07_Response_200_ShipmentErrors" } }, "shipment_success" : { "type" : "array", "description" : "Shipment update success", "items" : { "$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess" } } } }, "ST07_Response_200_ShipmentErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "message" : { "type" : "string", "description" : "Shipment update error message" } } }, "ST07_Response_200_ShipmentSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "shipping_from" : { "$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess_ShippingFrom", "description" : "Shipment's shipping origin" } } }, "ST07_Response_200_ShipmentSuccess_ShippingFrom" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess_ShippingFrom_Address", "description" : "Shipping origin address" }, "warehouse" : { "$ref" : "#/components/schemas/ST07_Response_200_ShipmentSuccess_ShippingFrom_Warehouse", "description" : "Shipping origin warehouse" } } }, "ST07_Response_200_ShipmentSuccess_ShippingFrom_Address" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "ST07_Response_200_ShipmentSuccess_ShippingFrom_Warehouse" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Warehouse's code" } } }, "ST11_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/ST11_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "ST11_Response_200_Data" : { "type" : "object", "properties" : { "created_date" : { "type" : "string", "format" : "date-time", "description" : "Shipment's creation date" }, "id" : { "type" : "string", "description" : "Shipment id" }, "invoice_reference" : { "type" : "string", "description" : "Shipment's invoice reference" }, "last_updated_date" : { "type" : "string", "format" : "date-time", "description" : "Shipment's last updated date" }, "order_id" : { "type" : "string", "description" : "Order id" }, "payment_details" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_PaymentDetails", "description" : "Shipment's payment details" }, "shipment_additional_information" : { "type" : "array", "description" : "Shipment's additional information", "items" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation" } }, "shipment_lines" : { "type" : "array", "description" : "Shipment lines", "items" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentLines" } }, "shipped_date" : { "type" : "string", "format" : "date-time", "description" : "Shipment's shipped date." }, "shipping_from" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShippingFrom", "description" : "Shipment's shipping origin" }, "status" : { "type" : "string", "description" : "Shipment status" }, "status_customer_debit" : { "type" : "string", "description" : "Shipment debit status" }, "tracking" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking", "description" : "Shipment tracking details" } } }, "ST11_Response_200_Data_PaymentDetails" : { "type" : "object", "properties" : { "customer_debited_date" : { "type" : "string", "format" : "date-time", "description" : "Payment's date of the shipment by the customer" }, "transaction_date" : { "type" : "string", "format" : "date-time", "description" : "Payment transaction date" }, "transaction_number" : { "type" : "string", "description" : "Payment transaction number" } } }, "ST11_Response_200_Data_ShipmentAdditionalInformation" : { "type" : "object", "discriminator" : { "mapping" : { "DATE" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation_Date", "STRING" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation_String" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "Shipment's additional information code" }, "type" : { "type" : "string", "description" : "Shipment's additional information type" } } }, "ST11_Response_200_Data_ShipmentAdditionalInformation_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "Shipment's additional information value" } } }, "ST11_Response_200_Data_ShipmentAdditionalInformation_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "Shipment's additional information value" } } }, "ST11_Response_200_Data_ShipmentLines" : { "type" : "object", "properties" : { "offer_sku" : { "type" : "string", "deprecated" : true, "description" : "Offer sku" }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "package_reference" : { "type" : "string", "description" : "Package reference" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity", "minimum" : 1 } } }, "ST11_Response_200_Data_ShippingFrom" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShippingFrom_Address", "description" : "Shipping origin address" }, "warehouse" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_ShippingFrom_Warehouse", "description" : "Shipping origin warehouse" } } }, "ST11_Response_200_Data_ShippingFrom_Address" : { "type" : "object", "properties" : { "city" : { "type" : "string", "description" : "City" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO code" }, "state" : { "type" : "string", "description" : "State" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "ST11_Response_200_Data_ShippingFrom_Warehouse" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Warehouse's code" } } }, "ST11_Response_200_Data_Tracking" : { "type" : "object", "properties" : { "carrier_code" : { "type" : "string", "description" : "The code of a carrier. This information is mandatory for a registered carrier." }, "carrier_expected_delivery_date" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate" }, "carrier_name" : { "type" : "string", "description" : "The name of a carrier. This information is mandatory for an unregistered carrier." }, "carrier_standard_code" : { "type" : "string", "description" : "The standard code of a carrier based on mirakl carrier referential" }, "last_known_location" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_LastKnownLocation", "description" : "The last location known and transmitted by carriers" }, "milestones" : { "type" : "array", "description" : "Retrieves the main stages of the delivery of a shipment coming from carrier's systems", "items" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones" } }, "tracking_number" : { "type" : "string", "description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number." }, "tracking_url" : { "type" : "string", "description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers." }, "validity_status" : { "type" : "string", "description" : "Retrieves if mirakl is able to get tracking information (if not, then unverified) and if we manage to get tracking information and if we do get tracking information on this tracking, then it moves to verified, if we don't it remains in unverified" } } }, "ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate" : { "type" : "object", "properties" : { "earliest" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Earliest" }, "latest" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Latest" } } }, "ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Earliest" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Latest" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST11_Response_200_Data_Tracking_LastKnownLocation" : { "type" : "object", "properties" : { "location" : { "type" : "string", "description" : "Last known location of the shipment" }, "occurrence_date" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_LastKnownLocation_OccurrenceDate", "description" : "Occurrence date of the known location" } } }, "ST11_Response_200_Data_Tracking_LastKnownLocation_OccurrenceDate" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST11_Response_200_Data_Tracking_Milestones" : { "type" : "object", "properties" : { "additional_info" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo", "description" : "Additional information about the current milestone" }, "occurrence_date" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones_OccurrenceDate", "description" : "Occurrence date" }, "type" : { "type" : "string", "description" : "Type of milestone" } } }, "ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo" : { "type" : "object", "properties" : { "occurrence_date" : { "$ref" : "#/components/schemas/ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo_OccurrenceDate", "description" : "Occurrence date" }, "type" : { "type" : "string", "description" : "Type of the additional information" } } }, "ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo_OccurrenceDate" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST11_Response_200_Data_Tracking_Milestones_OccurrenceDate" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "Date" }, "offset" : { "type" : "string", "description" : "Zone offset, with the following format (compliant with ISO8601) : ±hh:mm. The offset +00:00 can be replaced by Z (the zero UTC offset)." }, "time" : { "type" : "string", "description" : "Time, with the following format (compliant with ISO8601) : hh:mm[:ss]" } } }, "ST12_Response_200" : { "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "Page of data", "items" : { "$ref" : "#/components/schemas/ST12_Response_200_Data" } }, "next_page_token" : { "type" : "string", "description" : "Token to access the next page. Absent if the current page is the last one." }, "previous_page_token" : { "type" : "string", "description" : "Token to access the previous page. Absent if the current page is the first one." } } }, "ST12_Response_200_Data" : { "type" : "object", "properties" : { "fulfillment" : { "$ref" : "#/components/schemas/ST12_Response_200_Data_Fulfillment", "description" : "Fulfillment information" }, "order_id" : { "type" : "string", "description" : "Order id" }, "references" : { "$ref" : "#/components/schemas/ST12_Response_200_Data_References", "description" : "References" }, "shipment_lines" : { "type" : "array", "description" : "Shipment lines", "items" : { "$ref" : "#/components/schemas/ST12_Response_200_Data_ShipmentLines" } }, "shipping_address" : { "$ref" : "#/components/schemas/ST12_Response_200_Data_ShippingAddress", "description" : "Customer's shipping address" }, "shipping_date" : { "type" : "string", "format" : "date-time", "description" : "Shipping date" }, "shipping_deadline" : { "type" : "string", "format" : "date-time", "description" : "Shipping deadline" }, "shipping_type_code" : { "type" : "string", "description" : "Code of shipping's type" }, "shipping_type_standard_code" : { "type" : "string", "description" : "Shipping type's standard code" } } }, "ST12_Response_200_Data_Fulfillment" : { "type" : "object", "properties" : { "center" : { "$ref" : "#/components/schemas/ST12_Response_200_Data_Fulfillment_Center", "description" : "Fulfillment center code" } } }, "ST12_Response_200_Data_Fulfillment_Center" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Center code" } } }, "ST12_Response_200_Data_References" : { "type" : "object", "properties" : { "order_reference_for_customer" : { "type" : "string", "description" : "Order reference for customer" }, "order_reference_for_seller" : { "type" : "string", "description" : "Order reference for seller" } } }, "ST12_Response_200_Data_ShipmentLines" : { "type" : "object", "properties" : { "offer_sku" : { "type" : "string", "description" : "Offer sku" }, "order_line_id" : { "type" : "string", "description" : "Order line id" }, "package_description" : { "type" : "string", "deprecated" : true, "description" : "Package Description" }, "package_reference" : { "type" : "string", "description" : "Package reference" }, "product_title" : { "type" : "string", "description" : "Product title" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Quantity", "minimum" : 1 } } }, "ST12_Response_200_Data_ShippingAddress" : { "type" : "object", "properties" : { "additional_info" : { "type" : "string", "description" : "Additional information for the shipping address" }, "city" : { "type" : "string", "description" : "Address city" }, "civility" : { "type" : "string", "description" : "Civility of the person associated with the address" }, "company" : { "type" : "string", "description" : "Company of the person associated with the address" }, "company_2" : { "type" : "string", "description" : "Second company information of the person associated with the address" }, "country" : { "type" : "string", "description" : "Address country" }, "country_iso_code" : { "type" : "string", "description" : "Country ISO 3166-1 code of the address" }, "firstname" : { "type" : "string", "description" : "First name of the person associated with the address" }, "lastname" : { "type" : "string", "description" : "Last name of the person associated with the address" }, "phone" : { "type" : "string", "description" : "Phone" }, "phone_secondary" : { "type" : "string", "description" : "Phone secondary" }, "state" : { "type" : "string", "description" : "Address state" }, "street_1" : { "type" : "string", "description" : "First information line of the address street" }, "street_2" : { "type" : "string", "description" : "Second information line of the address street" }, "zip_code" : { "type" : "string", "description" : "Address zip code" } } }, "ST23_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "Shipments list", "items" : { "$ref" : "#/components/schemas/ST23_Request_Shipments" }, "maxItems" : 1000, "minItems" : 1 } } }, "ST23_Request_Shipments" : { "type" : "object", "description" : "Shipments list", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "tracking" : { "$ref" : "#/components/schemas/ST23_Request_Shipments_Tracking", "description" : "Shipment tracking details" } } }, "ST23_Request_Shipments_Tracking" : { "type" : "object", "description" : "Shipment tracking details", "properties" : { "carrier_code" : { "type" : "string", "description" : "The code of a carrier. This information is mandatory for a registered carrier." }, "carrier_name" : { "type" : "string", "description" : "The name of a carrier. This information is mandatory for an unregistered carrier." }, "carrier_standard_code" : { "type" : "string", "description" : "The standard code of a carrier based on mirakl carrier referential" }, "tracking_number" : { "type" : "string", "description" : "The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number." }, "tracking_url" : { "type" : "string", "description" : "The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.\n" } } }, "ST23_Response_200" : { "type" : "object", "properties" : { "shipment_errors" : { "type" : "array", "description" : "Shipment workflow update errors", "items" : { "$ref" : "#/components/schemas/ST23_Response_200_ShipmentErrors" } }, "shipment_success" : { "type" : "array", "description" : "Shipment workflow update success", "items" : { "$ref" : "#/components/schemas/ST23_Response_200_ShipmentSuccess" } } } }, "ST23_Response_200_ShipmentErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "ST23_Response_200_ShipmentSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST24_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "Shipment ids", "items" : { "$ref" : "#/components/schemas/ST24_Request_Shipments" }, "maxItems" : 1000, "minItems" : 1 } } }, "ST24_Request_Shipments" : { "type" : "object", "description" : "Shipment ids", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST24_Response_200" : { "type" : "object", "properties" : { "shipment_errors" : { "type" : "array", "description" : "Shipment workflow update errors", "items" : { "$ref" : "#/components/schemas/ST24_Response_200_ShipmentErrors" } }, "shipment_success" : { "type" : "array", "description" : "Shipment workflow update success", "items" : { "$ref" : "#/components/schemas/ST24_Response_200_ShipmentSuccess" } } } }, "ST24_Response_200_ShipmentErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "ST24_Response_200_ShipmentSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST26_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "Shipment ids", "items" : { "$ref" : "#/components/schemas/ST26_Request_Shipments" }, "maxItems" : 1000, "minItems" : 1 } } }, "ST26_Request_Shipments" : { "type" : "object", "description" : "Shipment ids", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST26_Response_200" : { "type" : "object", "properties" : { "shipment_errors" : { "type" : "array", "description" : "Shipment workflow update errors", "items" : { "$ref" : "#/components/schemas/ST26_Response_200_ShipmentErrors" } }, "shipment_success" : { "type" : "array", "description" : "Shipment workflow update success", "items" : { "$ref" : "#/components/schemas/ST26_Response_200_ShipmentSuccess" } } } }, "ST26_Response_200_ShipmentErrors" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "message" : { "type" : "string", "description" : "Error message" } } }, "ST26_Response_200_ShipmentSuccess" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Shipment id", "maxLength" : 2147483647, "minLength" : 1 } } }, "ST31_Request" : { "type" : "object", "properties" : { "shipments" : { "type" : "array", "description" : "List of shipments additional information", "items" : { "$ref" : "#/components/schemas/ST31_Request_Shipments" }, "maxItems" : 100, "minItems" : 1 } } }, "ST31_Request_Shipments" : { "type" : "object", "description" : "List of shipments additional information", "properties" : { "id" : { "type" : "string", "description" : "Shipment id" }, "shipment_additional_information" : { "type" : "array", "description" : "Shipment additional information", "items" : { "$ref" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation" } } } }, "ST31_Request_Shipments_ShipmentAdditionalInformation" : { "type" : "object", "description" : "Shipment additional information", "discriminator" : { "mapping" : { "DATE" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation_Date", "STRING" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation_String" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "The code associated to shipment additional information that you want to complete" }, "type" : { "type" : "string", "description" : "The type associated to the shipment additional information that you want to complete" }, "value" : { "type" : "object", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST31_Request_Shipments_ShipmentAdditionalInformation_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST31_Request_Shipments_ShipmentAdditionalInformation_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST31_Request_Shipments_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST31_Response_200" : { "type" : "object", "properties" : { "shipment_update_errors" : { "type" : "array", "description" : "Shipment additional information update errors", "items" : { "$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateErrors" } }, "shipment_update_success" : { "type" : "array", "description" : "Shipment additional information update success", "items" : { "$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess" } } } }, "ST31_Response_200_ShipmentUpdateErrors" : { "type" : "object", "properties" : { "errors" : { "type" : "array", "description" : "List of errors", "items" : { "$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateErrors_Errors" } }, "shipment_id" : { "type" : "string", "description" : "Shipment id" } } }, "ST31_Response_200_ShipmentUpdateErrors_Errors" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Error code" }, "field" : { "type" : "string", "description" : "Name of the field on the input object. Can be composed, e.g.: address.zip_code" }, "message" : { "type" : "string", "description" : "Error message" } } }, "ST31_Response_200_ShipmentUpdateSuccess" : { "type" : "object", "properties" : { "shipment_additional_information" : { "type" : "array", "description" : "Shipment additional information", "items" : { "$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation" } }, "shipment_id" : { "type" : "string", "description" : "Shipment id" } } }, "ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation" : { "type" : "object", "discriminator" : { "mapping" : { "DATE" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_Date", "STRING" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_String" }, "propertyName" : "type" }, "properties" : { "code" : { "type" : "string", "description" : "The code associated to shipment additional information that you want to complete" }, "type" : { "type" : "string", "description" : "The type associated to the shipment additional information that you want to complete" }, "value" : { "type" : "object", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_Date" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation_String" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation" } ], "properties" : { "value" : { "type" : "string", "description" : "The value associated to the shipment additional information that you want to complete for this specific shipment" } } }, "STO01_Response_201" : { "type" : "object", "properties" : { "import_id" : { "type" : "string", "description" : "Offer stock import identifier" } } }, "STO02_Response_200" : { "type" : "object", "properties" : { "date_created" : { "type" : "string", "format" : "date-time", "description" : "Import creation date" }, "has_error_report" : { "type" : "boolean", "description" : "Indicate if an error report exists" }, "import_id" : { "type" : "string", "description" : "Import ID" }, "lines_in_error" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in error" }, "lines_in_success" : { "type" : "integer", "format" : "int32", "description" : "Total count of lines in success" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop identifier" }, "status" : { "type" : "string", "description" : "Import status" } } }, "VL11_Response_200" : { "type" : "object", "properties" : { "values_lists" : { "type" : "array", "description" : "List of values list", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists" } } } }, "VL11_Response_200_ValuesLists" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Value list code" }, "label" : { "type" : "string", "description" : "Value list label" }, "label_translations" : { "type" : "array", "description" : "Value list translations", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_LabelTranslations" } }, "values" : { "type" : "array", "description" : "Value list's of value list", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_Values" } } } }, "VL11_Response_200_ValuesLists_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } }, "VL11_Response_200_ValuesLists_Values" : { "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "Value code" }, "label" : { "type" : "string", "description" : "Value label" }, "label_translations" : { "type" : "array", "description" : "Value label translation", "items" : { "$ref" : "#/components/schemas/VL11_Response_200_ValuesLists_Values_LabelTranslations" } } } }, "VL11_Response_200_ValuesLists_Values_LabelTranslations" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "Locale" }, "value" : { "type" : "string", "description" : "Translation" } } } }, "securitySchemes" : { "OAuth-2" : { "description" : "For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partners_integration/authentication_system.htm)", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://auth.mirakl.net/authorize", "refreshUrl" : "https://auth.mirakl.net/oauth/token", "scopes" : { }, "tokenUrl" : "https://auth.mirakl.net/oauth/token" } }, "type" : "oauth2" }, "Operator-Bearer-Token" : { "bearerFormat" : "JWT", "scheme" : "bearer", "type" : "http" } } }, "info" : { "title" : "Mirakl Marketplace APIs", "version" : "latest-release" }, "openapi" : "3.0.1", "paths" : { "/api/additional_fields" : { "get" : { "description" : "", "operationId" : "AF01", "parameters" : [ { "description" : "A comma separated list of entities on which the additional fields must apply. Accepted values are OFFER, SHOP, ORDER and ORDER_LINE. Ex: OFFER,SHOP.", "explode" : true, "in" : "query", "name" : "entities", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/AF01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all custom fields", "tags" : [ "Platform Settings" ] } }, "/api/channels" : { "get" : { "description" : "Results are sorted by code", "operationId" : "CH11", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/CH11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all enabled channels", "tags" : [ "Platform Settings" ] } }, "/api/currencies" : { "get" : { "description" : "List currency codes and labels activated on the platform", "operationId" : "CUR01", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/CUR01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List currency codes and labels", "tags" : [ "Platform Settings" ] } }, "/api/documents" : { "get" : { "description" : "", "operationId" : "DO01", "parameters" : [ { "description" : "A comma separated list of values, representing the type of entities the document type should be related to. Accepted values are ORDER, SHOP. Ex: ORDER,SHOP", "explode" : true, "in" : "query", "name" : "entities", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/DO01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all document types", "tags" : [ "Platform Settings" ] } }, "/api/document-request/requests" : { "get" : { "description" : "", "operationId" : "DR11", "parameters" : [ { "description" : "Filter by accounting document request identifier.", "explode" : true, "in" : "query", "name" : "id", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Filter by accounting document number.", "explode" : true, "in" : "query", "name" : "document_number", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Filter accounting document requests created after the given date.", "explode" : true, "in" : "query", "name" : "date_created_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter accounting document requests created before the given date.", "explode" : true, "in" : "query", "name" : "date_created_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter accounting document requests updated after the given date.", "explode" : true, "in" : "query", "name" : "last_updated_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter accounting document requests updated before the given date.", "explode" : true, "in" : "query", "name" : "last_updated_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter accounting document requests issued after the given date.", "explode" : true, "in" : "query", "name" : "issue_date_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter accounting document requests issued before the given date.", "explode" : true, "in" : "query", "name" : "issue_date_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter by accounting document request state. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "state", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Filter by accounting document request type. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "type", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Filter by accounting document request issuer type. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "issuer_type", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Filter by the shop identifier linked to the accounting document request entity. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "shop_ids", "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Filter by accounting document request entity identifier. This parameter can be supplied multiple times.\n\nThe `entity_type` must be specified to use this filter, otherwise an error 400 will be returned.\n\nExample: `entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER`", "explode" : true, "in" : "query", "name" : "entity_id", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Filter by accounting document request entity type. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "entity_type", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Filter accounting document requests generated by a shop billing cycle having the given identifier.\n\nThis filter is only available for document requests of the type: `FEES`, `ONE_OFF_FEES`, `SHOP_BILLING_CYCLE_PURCHASE_ORDER`.", "explode" : true, "in" : "query", "name" : "shop_billing_cycle_id", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Filter accounting document requests generated by shop billing cycle after the given date.\n\nThis filter is only available for document requests of the type: `FEES`, `ONE_OFF_FEES`, `SHOP_BILLING_CYCLE_PURCHASE_ORDER`.\n\nThis parameter was previously named `billing_cycle_from`, which is still accepted but deprecated.", "explode" : true, "in" : "query", "name" : "shop_billing_cycle_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter accounting document requests generated by shop billing cycle before the given date.\n\nThis filter is only available for document requests of the type: `FEES`, `ONE_OFF_FEES`, `SHOP_BILLING_CYCLE_PURCHASE_ORDER`.\n\nThis parameter was previously named `billing_cycle_to`, which is still accepted but deprecated.", "explode" : true, "in" : "query", "name" : "shop_billing_cycle_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter by accounting document request payment state.\n\nThis filter is only available for document requests of the type: `SHOP_BILLING_CYCLE_PURCHASE_ORDER`, `LOGISTIC_PURCHASE_ORDER`, `FEES`.", "explode" : true, "in" : "query", "name" : "payment_state", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/DR11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List accounting documents requests", "tags" : [ "Invoicing and Accounting" ] } }, "/api/document-request/{document_request_id}/lines" : { "get" : { "description" : "", "operationId" : "DR12", "parameters" : [ { "description" : "Document Request identifier", "explode" : false, "in" : "path", "name" : "document_request_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/DR12_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List lines of a document request", "tags" : [ "Invoicing and Accounting" ] } }, "/api/document-request/documents/download" : { "get" : { "description" : "At least one of the following filters must be applied: document_id or entity_id
    If more than one document is requested, the output of the API will be a ZIP archive.
    The tree structure of this archive is as follows:
    \ndocuments-1624624030618.zip\n|\n|__ product-logistic-order/\n|   |__order1-A/|      |__ INV203837.pdf\n|      |__ INV203837.cxml\n|   |__order1-B/|      |__ INV203839.pdf\n
    ", "operationId" : "DR73", "parameters" : [ { "description" : "The document request unique identifier. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "document_request_id", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Document identifiers. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "document_id", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Document formats. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "document_format", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" }, { "description" : "Entity identifiers related to the documents to download. This parameter can be supplied multiple times.
    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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" }, "maxItems" : 100, "minItems" : 0 }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Download accounting documents", "tags" : [ "Invoicing and Accounting" ] } }, "/api/document-request/documents/confirm-issuance" : { "post" : { "description" : "For fees documents (FEES, ONE_OFF_FEES) issued externally, confirms the issuance details without uploading a document.
    A maximum of 100 requests can be confirmed simultaneously.", "operationId" : "DR75", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DR75_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/DR75_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Confirm accounting documents issuance", "tags" : [ "Invoicing and Accounting" ] } }, "/api/hierarchies" : { "get" : { "description" : "", "operationId" : "H11", "parameters" : [ { "description" : "Catalog category code", "explode" : true, "in" : "query", "name" : "hierarchy", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Number of children catalog category levels to retrieve. If not specified, all child catalog categories are retrieved", "explode" : true, "in" : "query", "name" : "max_level", "schema" : { "type" : "integer", "format" : "int32" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/H11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List Catalog categories (parents and children) related to a Catalog category", "tags" : [ "Products" ] } }, "/api/invoices" : { "get" : { "description" : "⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, IV01 will contain no new data. Use the SBC11 and DR11 APIs instead.", "operationId" : "IV01", "parameters" : [ { "description" : "Currency code for filtering", "explode" : true, "in" : "query", "name" : "currency", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Creation date for filtering", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Invoice IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.", "explode" : true, "in" : "query", "name" : "invoice_id", "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" }, "maxItems" : 100 }, "style" : "form" }, { "description" : "A comma separated list of issuing user type for filtering. By default all types are returned", "explode" : true, "in" : "query", "name" : "issuing_user_types", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.", "explode" : true, "in" : "query", "name" : "pay_out_psp_codes", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Accounting document payment state", "explode" : true, "in" : "query", "name" : "payment_status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Payment voucher for filtering", "explode" : true, "in" : "query", "name" : "payment_voucher_number", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Seller billing cycle IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.", "explode" : true, "in" : "query", "name" : "seller_billing_cycle_id", "schema" : { "type" : "array", "items" : { "type" : "string", "maxLength" : 36, "minLength" : 36 }, "maxItems" : 100 }, "style" : "form" }, { "description" : "Shop identifier for filtering", "explode" : true, "in" : "query", "name" : "shop", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "A comma separated list of shop model for filtering", "explode" : true, "in" : "query", "name" : "shop_model", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Operator internal id of the shop for filtering", "explode" : true, "in" : "query", "name" : "shop_operator_internal_id", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Creation date for filtering", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "A comma separated list of state of the accounting document for filtering", "explode" : true, "in" : "query", "name" : "states", "schema" : { "type" : "array", "default" : [ "GENERATED", "COMPLETE" ], "items" : { "type" : "string", "default" : "GENERATED,COMPLETE" } }, "style" : "form" }, { "description" : "Accounting document type for filtering. By default only invoices by the shop payment process are returned.", "explode" : true, "in" : "query", "name" : "type", "schema" : { "type" : "string", "default" : "AUTO_INVOICE" }, "style" : "form" }, { "description" : "Maximum number of items returned per page", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Index of the first item (among all the results) in the returned page", "in" : "query", "name" : "offset", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "How the results should be sorted", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } }, { "description" : "Sort direction", "in" : "query", "name" : "order", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/IV01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List accounting documents", "tags" : [ "Invoicing and Accounting" ] } }, "/api/invoices/{accounting_document_id}" : { "get" : { "description" : "⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, the DR73 API should be used. Only documents created prior to the toggle activation remain downloadable via this API.", "operationId" : "IV02", "parameters" : [ { "description" : "Accounting document identifier", "explode" : false, "in" : "path", "name" : "accounting_document_id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Download an accounting document", "tags" : [ "Invoicing and Accounting" ] } }, "/api/locales" : { "get" : { "description" : "List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system", "operationId" : "L01", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/L01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List locale codes and labels", "tags" : [ "Platform Settings" ] } }, "/api/inbox/threads/{thread_id}" : { "get" : { "description" : "", "operationId" : "M10", "parameters" : [ { "description" : "The identifier of the thread to retrieve.", "explode" : false, "in" : "path", "name" : "thread_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/M10_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Retrieve a thread", "tags" : [ "Messages" ] } }, "/api/inbox/threads" : { "get" : { "description" : "You may want to retrieve the threads linked to a specific entity, using both entity_type and entity_id.\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\nThis resource uses seek pagination. The default value for parameter limit is 50.\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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Retrieve threads modified at or after this date.", "explode" : true, "in" : "query", "name" : "updated_since", "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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/M11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all threads", "tags" : [ "Messages" ] } }, "/api/inbox/threads/{attachment_id}/download" : { "get" : { "description" : "", "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" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Download an attachment", "tags" : [ "Messages" ] } }, "/api/offers/imports" : { "post" : { "description" : "Returns the import identifier to track the status of the import.", "operationId" : "OF01", "parameters" : [ ], "requestBody" : { "content" : { "multipart/form-data" : { "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" }, "operator_format" : { "type" : "boolean", "default" : false, "description" : "Force the use of the operator product format" }, "shop" : { "type" : "integer", "format" : "int64", "description" : "Shop Identifier" }, "with_products" : { "type" : "boolean", "default" : false, "description" : "This file also contains product information" } } } } } }, "responses" : { "201" : { "content" : { "application/json" : { "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" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Import a file to create, update or delete offers", "tags" : [ "Offers" ] }, "get" : { "description" : "", "operationId" : "OF04", "parameters" : [ { "description" : "Shop identifier", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "Start creation date for filtering", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "End creation date for filtering", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Offer import status", "explode" : true, "in" : "query", "name" : "status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Offer import mode", "explode" : true, "in" : "query", "name" : "mode", "schema" : { "type" : "string" }, "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF04_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get information and statistics about offer imports", "tags" : [ "Offers" ] } }, "/api/offers/imports/{import}" : { "get" : { "description" : "", "operationId" : "OF02", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF02_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get information and statistics about an offer import", "tags" : [ "Offers" ] } }, "/api/offers/imports/{import}/error_report" : { "get" : { "description" : "This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.", "operationId" : "OF03", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the error report file for an offer import", "tags" : [ "Offers" ] } }, "/api/offers/{offer}" : { "get" : { "description" : "", "operationId" : "OF22", "parameters" : [ { "description" : "Offer identifier", "explode" : false, "in" : "path", "name" : "offer", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" }, { "description" : "Filter used to pick prices on a specific channel", "explode" : true, "in" : "query", "name" : "pricing_channel_code", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.", "explode" : true, "in" : "query", "name" : "pricing_customer_organization_id", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF22_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get information about an offer", "tags" : [ "Offers" ] } }, "/api/offers" : { "post" : { "description" : "

    Returns the import identifier to track the status of the update.

    You must send all offer fields. Offer fields that are not sent are reset to their default value.

    ", "operationId" : "OF24", "parameters" : [ { "description" : "Shop ID", "explode" : true, "in" : "query", "name" : "shop", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OF24_Request" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF24_Response_201" } } }, "description" : "Created", "headers" : { "Location" : { "description" : "Pre-calculated URL to call to get the import status", "explode" : false, "schema" : { }, "style" : "simple" } } } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Create, update, or delete offers", "tags" : [ "Offers" ] } }, "/api/offers/export" : { "get" : { "deprecated" : true, "description" : "Get a CSV file that includes the offers updated and deleted since the last request date.
    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.", "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", "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", "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", "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", "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", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A comma separated list of platform models to filter with. Accepted values are MARKETPLACE, DROPSHIP, ONE_CREDITOR", "explode" : true, "in" : "query", "name" : "models", "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get offers CSV file", "tags" : [ "Offers" ] } }, "/api/offers/export/async" : { "post" : { "description" : "Export 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", "operationId" : "OF52", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OF52_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF52_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Export offers CSV or JSON file asynchronously", "tags" : [ "Offers" ] } }, "/api/offers/export/async/status/{tracking_id}" : { "get" : { "description" : "Retrieve the status for an OF52 offer export.
    \nWhen the export is complete, the URLs to retrieve the files are returned.\n", "operationId" : "OF53", "parameters" : [ { "description" : "The asynchronous offer export id", "explode" : false, "in" : "path", "name" : "tracking_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF53_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Poll the status of an asynchronous offer export (OF52)", "tags" : [ "Offers" ] } }, "/api/offers/states" : { "get" : { "description" : "Sorted by sort index, set in the back-office", "operationId" : "OF61", "parameters" : [ { "description" : "Filter offer condition on their active status. If true, only active offer conditions are returned. If false, only inactive offer conditions are returned. If not specified, all offer conditions are returned.", "explode" : true, "in" : "query", "name" : "active", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OF61_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List offer conditions", "tags" : [ "Platform Settings" ] } }, "/api/orders" : { "put" : { "description" : "

    Update orders information field by field: unspecified fields will not be updated. To remove the value for a field, send it with the 'null' value (not allowed for the required fields).

    You cannot use API OR04 to update customer-related information if the customer has been anonymized via API AN01.

    A maximum of 100 orders can be sent at once.

    ", "operationId" : "OR04", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR04_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR04_Response_200" } } }, "description" : "OK" }, "400" : { "description" : "Too many orders given" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Patch update orders", "tags" : [ "Orders" ] }, "get" : { "description" : "Returns a 400 Bad Request response if the limit of commercialIds, customerIds, offerIds or productSkus is exceeded.
    Pagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead.
    ", "operationId" : "OR11", "parameters" : [ { "description" : "A comma-separated list of order commercial's identifiers", "explode" : true, "in" : "query", "name" : "commercial_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of customer's identifiers", "explode" : true, "in" : "query", "name" : "customer_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of customer organization's identifiers", "explode" : true, "in" : "query", "name" : "customer_organization_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A comma-separated list of offer's identifiers", "explode" : true, "in" : "query", "name" : "offer_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of order's identifiers", "explode" : true, "in" : "query", "name" : "order_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of shop's identifiers", "explode" : true, "in" : "query", "name" : "shop_ids", "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", "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", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of product's skus", "explode" : true, "in" : "query", "name" : "product_skus", "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", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A comma-separated list of channel codes", "explode" : true, "in" : "query", "name" : "channel_codes", "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", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" }, { "description" : "Start creation date for filtering", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "End creation date for filtering", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Start update date for filtering. Mirakl will subtract a time delta to ensure no orders are missed due to network and/or software latency.", "explode" : true, "in" : "query", "name" : "start_update_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "End update date for filtering", "explode" : true, "in" : "query", "name" : "end_update_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Order paid by customer", "explode" : true, "in" : "query", "name" : "customer_debited", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Payment workflow of an order", "explode" : true, "in" : "query", "name" : "payment_workflow", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If true returns only orders with incidents in progress, if false returns orders without incidents in progress. If not provided, all orders with or without incident will be returned", "explode" : true, "in" : "query", "name" : "has_incident", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Code of the fulfillment center", "explode" : true, "in" : "query", "name" : "fulfillment_center_code", "schema" : { "type" : "array", "items" : { "type" : "string", "maximum" : 100 }, "maximum" : 100 }, "style" : "form" }, { "description" : "Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts.
    Possible values:
  • 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", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If true returns only orders with commission, if false returns orders without commission. Please note that this filter is available only when the platform is in mixed commission model", "explode" : true, "in" : "query", "name" : "commissionable", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If true returns only orders awaiting a tax confirmation, When false it does not impact the result.", "explode" : true, "in" : "query", "name" : "waiting_tax_confirmation", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If true returns only orders for which taxes must be recalculated on at least one order line. When false it does not impact the result. Must be used with at least one date range filter: created or last updated date, of a maximum duration of one month.", "explode" : true, "in" : "query", "name" : "tax_recalculation_required_only", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "If true returns only orders awaiting a funding update. When false it does not impact the result.", "explode" : true, "in" : "query", "name" : "waiting_funding_confirmation", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "A comma-separated list of refund state's codes.
    \nMust be used in combination with filters start_update_date and end_update_date, with a maximum of one month period.\n", "explode" : true, "in" : "query", "name" : "refund_state_codes", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } }, { "description" : "Maximum number of items returned per page", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Index of the first item (among all the results) in the returned page", "in" : "query", "name" : "offset", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "How the results should be sorted", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } }, { "description" : "Sort direction", "in" : "query", "name" : "order", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List orders with pagination", "tags" : [ "Orders" ] } }, "/api/orders/shipping_from" : { "put" : { "description" : "

    Update shipping origin (shipping_from) information on order lines.

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

    ", "operationId" : "OR07", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR07_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR07_Response_200" } } }, "description" : "OK" }, "400" : { "description" : "Too many order lines specified" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update order line shipping origin", "tags" : [ "Orders" ] } }, "/api/orders/async-export" : { "post" : { "description" : "

    The API returns a tracking id to be used to query API OR14.
    Mirakl recommends to use API OR13 instead of API OR11 as it can handle very large volumes of data.
    You must give at least one date range filter: created, last updated date or refunds created date.
    API OR13 supports the chunk of the export file into multiple files in order to:


    Only one export request can be created for all operator users, and one per partner.", "operationId" : "OR13", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR13_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR13_Response_200" } } }, "description" : "Asynchronous order export tracking creation success" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Export orders asynchronously", "tags" : [ "Orders" ] } }, "/api/orders/async-export/status/{tracking_id}" : { "get" : { "description" : "

    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.

    ", "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" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR14_Response_200" } } }, "description" : "Order asynchronous export tracking polling success" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the status of an asynchronous order export.", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/accept" : { "put" : { "description" : "Accept 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", "operationId" : "OR21", "parameters" : [ { "description" : "Order's identifier", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR21_Request" } } } }, "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Accept or refuse order lines", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/tracking" : { "put" : { "description" : "If the carrier is not registered, the complete tracking url can be provided.", "operationId" : "OR23", "parameters" : [ { "description" : "Order identifier", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR23_Request" } } } }, "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update carrier tracking information for a specific order", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/ship" : { "put" : { "description" : "Validate the shipment of an order in the SHIPPING status", "operationId" : "OR24", "parameters" : [ { "description" : "Order's identifier", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Validate the shipment of an order", "tags" : [ "Orders" ] } }, "/api/orders/refund" : { "put" : { "description" : "", "operationId" : "OR28", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR28_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR28_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Perform refunds on order lines", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/cancel" : { "put" : { "description" : "", "operationId" : "OR29", "parameters" : [ { "description" : "Order's identifier", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Perform a full cancelation of an order", "tags" : [ "Orders" ] } }, "/api/orders/cancel" : { "put" : { "description" : "If the Shop partial cancelation feature is enabled by Mirakl Support Team:", "operationId" : "OR30", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR30_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR30_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Perform cancelations on order lines", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/additional_fields" : { "put" : { "description" : "Only 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:", "operationId" : "OR31", "parameters" : [ { "description" : "Order identifier", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR31_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR31_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update the custom fields of an order and its order lines", "tags" : [ "Orders" ] } }, "/api/orders/adjust" : { "put" : { "description" : "

    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", "operationId" : "OR32", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR32_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR32_Response_200" } } }, "description" : "OK" }, "400" : { "description" : "Too many order lines given" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Adjust order line", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/cancel-order-lines" : { "put" : { "description" : "If the Shop partial cancelation feature is enabled by Mirakl Support Team:", "operationId" : "OR33", "parameters" : [ { "description" : "Order's identifier", "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OR33_Request" } } } }, "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Fully cancel a list of order lines of an order", "tags" : [ "Orders" ] } }, "/api/orders/{order_id}/evaluation" : { "get" : { "description" : "", "operationId" : "OR51", "parameters" : [ { "explode" : false, "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR51_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the evaluation of an order", "tags" : [ "Orders" ] } }, "/api/orders/documents" : { "get" : { "description" : "Returns a list of all the documents available on the order", "operationId" : "OR72", "parameters" : [ { "description" : "the orders' identifiers, using comma as separator", "explode" : true, "in" : "query", "name" : "order_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR72_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Lists order's documents", "tags" : [ "Orders" ] } }, "/api/orders/documents/download" : { "get" : { "description" : "When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow:
    \ndocuments-timestamp.zip\n|\n|__ order_id_x/\n|   |__ foo.txt\n|   |__ bar.txt\n|   |__ baz.pdf\n|\n|__ order_id_y/\n|   |__ image.png\n|   |__ image(1).png\n
    ", "operationId" : "OR73", "parameters" : [ { "description" : "A list of identifiers of the orders (separated by a comma)", "explode" : true, "in" : "query", "name" : "order_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A list of document identifiers (separated by a comma)", "explode" : true, "in" : "query", "name" : "document_ids", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" }, { "description" : "A list of document type codes (separated by a comma)", "explode" : true, "in" : "query", "name" : "document_codes", "schema" : { "type" : "string", "maximum" : 100 }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Download one or multiple documents attached to one or multiple orders", "tags" : [ "Orders" ] } }, "/api/orders/taxes" : { "get" : { "description" : "", "operationId" : "OR75", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/OR75_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all the order taxes available on the platform", "tags" : [ "Orders" ] } }, "/api/orders/documents/{document_id}" : { "delete" : { "description" : "", "operationId" : "OR76", "parameters" : [ { "description" : "Identifier of the document to delete", "explode" : false, "in" : "path", "name" : "document_id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Delete an order document", "tags" : [ "Orders" ] } }, "/api/products/offers" : { "get" : { "description" : "List offers for each given product\n\n
    \nBy default, users calling this API with a Seller API key can retrieve both their own offers and some of their competitors’ data. If you want to prevent them from accessing competitors’ data, please contact the Mirakl Support Team.\n
    \n", "operationId" : "P11", "parameters" : [ { "description" : "List of product's skus separated with comma. Limited to 100 values.\n\nOne of the two is required `product_ids` or `product_references`.\n", "explode" : true, "in" : "query", "name" : "product_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "List of the product's identifiers with type _(structure: \"`product_references=|,|, ...`\")_.
    \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", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "List of offer state codes", "explode" : true, "in" : "query", "name" : "offer_state_codes", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If `true`, returns only offers of premium shops.
    \nIf `false`, returns only offers of shops that are not premium.\n", "explode" : true, "in" : "query", "name" : "premium", "schema" : { "type" : "string", "default" : "ALL" }, "style" : "form" }, { "description" : "If false returns only active offers. If true return all offers.", "explode" : true, "in" : "query", "name" : "all_offers", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" }, { "description" : "List of the channel codes to filter with, using a comma (,) as a separator. If specified, only offers that can be sold on the specified channel(s) will be returned. If not, offers will be returned regardless of their channels.", "explode" : true, "in" : "query", "name" : "channel_codes", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If `false`, filters the offers with the given `channel_codes` or the default channel if no `channel_codes` are given.
    \nIf `true`, does not filter the offers on channels and ignore the `channel_codes`.\n", "explode" : true, "in" : "query", "name" : "all_channels", "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", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.", "explode" : true, "in" : "query", "name" : "pricing_customer_organization_id", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "List of shop IDs separated with comma. Limited to 100 values.\n\nFilter used to return only the offers of the listed shops.\n", "explode" : true, "in" : "query", "name" : "shop_ids", "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", "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", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" }, { "description" : "A comma separated list of platform models to filter with.
    \nAccepted values are `MARKETPLACE`, `DROPSHIP`, `ONE_CREDITOR`\n", "explode" : true, "in" : "query", "name" : "models", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } }, { "description" : "Maximum number of items returned per page", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Index of the first item (among all the results) in the returned page", "in" : "query", "name" : "offset", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "How the results should be sorted", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } }, { "description" : "Sort direction", "in" : "query", "name" : "order", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/P11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List offers for each given product", "tags" : [ "Offers" ] } }, "/api/products" : { "get" : { "description" : "Note: 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", "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", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/P31_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get products for a list of product references", "tags" : [ "Products" ] } }, "/api/products/imports/{import}" : { "get" : { "description" : "", "operationId" : "P42", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/P42_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the import status for a product import", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/error_report" : { "get" : { "description" : "This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).", "operationId" : "P44", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the error report file for a product import (\"Non-integrated products report\")", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/new_product_report" : { "get" : { "description" : "This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled).", "operationId" : "P45", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the product integration report file for a product import (\"Added products report\")", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/transformed_file" : { "get" : { "description" : "This API returns a CSV file.", "operationId" : "P46", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the transformed file for a product import (\"File in operator format\")", "tags" : [ "Products" ] } }, "/api/products/imports/{import}/transformation_error_report" : { "get" : { "description" : "This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller.", "operationId" : "P47", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the transformation error report file for a product import (\"Source file error report\")", "tags" : [ "Products" ] } }, "/api/products/imports" : { "get" : { "description" : "If the last_request_date param is not set the api returns all product imports.", "operationId" : "P51", "parameters" : [ { "description" : "Return only product imports that have changed since this date", "explode" : true, "in" : "query", "name" : "last_request_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Product import status. One of CANCELLED, WAITING, RUNNING, SENT, COMPLETE, FAILED", "explode" : true, "in" : "query", "name" : "status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "If true returns only product import trackings with transformed file", "explode" : true, "in" : "query", "name" : "has_transformed_file", "schema" : { "type" : "boolean" }, "style" : "form" }, { "description" : "Shop identifier", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "Maximum number of items returned per page", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Index of the first item (among all the results) in the returned page", "in" : "query", "name" : "offset", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "How the results should be sorted", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } }, { "description" : "Sort direction", "in" : "query", "name" : "order", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/P51_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get information about product import statuses", "tags" : [ "Products" ] } }, "/api/platform/configuration" : { "get" : { "description" : "List platform configurations such as general information, modules and features activated.
    \n
    \nNote: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office.\n", "operationId" : "PC01", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PC01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List platform configurations", "tags" : [ "Platform Settings" ] } }, "/api/picklists" : { "get" : { "description" : "", "operationId" : "PL11", "parameters" : [ { "description" : "Pick run code for filtering.", "explode" : true, "in" : "query", "name" : "pickrun_code", "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", "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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Shop id for filtering.", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PL11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List picklists", "tags" : [ "Picklists" ] } }, "/api/products/attributes" : { "get" : { "description" : "Retrieves all attributes for parents and children of the requested hierarchy", "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", "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", "schema" : { "type" : "integer", "format" : "int32" }, "style" : "form" }, { "description" : "List of channel codes", "explode" : true, "in" : "query", "name" : "channels", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Set to \"true\" to get only the attributes that have roles.", "explode" : true, "in" : "query", "name" : "with_roles", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PM11_Response_200" } }, "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "Export success" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the product attribute configuration", "tags" : [ "Products" ] } }, "/api/promotions" : { "get" : { "description" : "", "operationId" : "PR01", "parameters" : [ { "description" : "A comma separated list of identifiers for shop joined to an identifier for a promotion (structure: \"ids=<shopId>|<promotionShopInternalId>,<shopId>|<promotionShopInternalId>, ...\" Example: /api/promotion?ids=123|promo-dec-2016)", "explode" : true, "in" : "query", "name" : "ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A comma separated list of types for a promotion [AMOUNT_OFF|FREE_ITEMS|PERCENTAGE_OFF|REDUCED_UNIT_PRICE]", "explode" : true, "in" : "query", "name" : "types", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A comma separated list of states for a promotion [PENDING|ACTIVE|EXPIRED|PENDING_APPROVAL|REJECTED|ALL]", "explode" : true, "in" : "query", "name" : "states", "schema" : { "type" : "string", "default" : "ACTIVE" }, "style" : "form" }, { "description" : "A comma separated list of shop ids", "explode" : true, "in" : "query", "name" : "shop_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Returns promotions which ended or will end after this date", "explode" : true, "in" : "query", "name" : "ending_after", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Returns promotions which started or will start before this date", "explode" : true, "in" : "query", "name" : "starting_before", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter promotion creation date lower limit", "explode" : true, "in" : "query", "name" : "date_created_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter promotion creation date upper limit", "explode" : true, "in" : "query", "name" : "date_created_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Last request date and time. We recommend using the differential mode along with the states parameter.", "explode" : true, "in" : "query", "name" : "last_request_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "The locale to filter the medias and the public descriptions with. If not specified, medias and public descriptions of all locales are returned.If specified, only the media and the public description matching the locale will be returned, or, if not exist, the one matching the platform default locale.", "explode" : true, "in" : "query", "name" : "locale", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Promotion-triggering offer ids, separated by commas", "explode" : true, "in" : "query", "name" : "trigger_offer_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Promotion reward offer ids, separated by commas", "explode" : true, "in" : "query", "name" : "reward_offer_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Channel codes on which promotions apply, separated by commas", "explode" : true, "in" : "query", "name" : "channel_codes", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A comma separated list of campaign identifiers", "explode" : true, "in" : "query", "name" : "campaign_identifiers", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "Maximum number of items returned per page", "in" : "query", "name" : "max", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Index of the first item (among all the results) in the returned page", "in" : "query", "name" : "offset", "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "How the results should be sorted", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } }, { "description" : "Sort direction", "in" : "query", "name" : "order", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PR01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List promotions", "tags" : [ "Promotions" ] }, "post" : { "description" : "", "operationId" : "PR03", "parameters" : [ { "description" : "Shop Identifier", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PR03_Request" } } } }, "responses" : { "201" : { "description" : "Created", "headers" : { "Location" : { "description" : "URI of the created promotion", "explode" : false, "schema" : { }, "style" : "simple" } } } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Create a promotion", "tags" : [ "Promotions" ] } }, "/api/promotions/{promotion_internal_id}" : { "put" : { "description" : "", "operationId" : "PR04", "parameters" : [ { "description" : "Shop Identifier", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "Promotion internal identifier", "explode" : false, "in" : "path", "name" : "promotion_internal_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PR04_Request" } } } }, "responses" : { "200" : { "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update a promotion", "tags" : [ "Promotions" ] } }, "/api/offers/pricing/imports" : { "post" : { "description" : "Import 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", "operationId" : "PRI01", "parameters" : [ ], "requestBody" : { "content" : { "multipart/form-data" : { "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" }, "shop" : { "type" : "integer", "format" : "int64", "description" : "Shop Identifier" } } } } } }, "responses" : { "201" : { "content" : { "application/json" : { "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" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Import a price file", "tags" : [ "Offers" ] }, "get" : { "description" : "", "operationId" : "PRI02", "parameters" : [ { "description" : "Import identifiers", "explode" : true, "in" : "query", "name" : "import_id", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Shop identifier", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "integer", "format" : "int64" }, "style" : "form" }, { "description" : "Start creation date for filtering", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "End creation date for filtering", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Offer import status", "explode" : true, "in" : "query", "name" : "status", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "List of offer pricing import origins for filtering.", "explode" : true, "in" : "query", "name" : "origins", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/PRI02_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get information and statistics about an offer pricing import", "tags" : [ "Offers" ] } }, "/api/offers/pricing/imports/{import_id}/error_report" : { "get" : { "description" : "Only 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", "operationId" : "PRI03", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the error report for a price import in CSV format", "tags" : [ "Offers" ] } }, "/api/reasons" : { "get" : { "description" : "This API returns cancellation, refund, incident, and message reasons.
    Reasons are sorted by type then sort index (set in the back-office)", "operationId" : "RE01", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RE01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List reasons", "tags" : [ "Platform Settings" ] } }, "/api/users/shops/roles" : { "get" : { "description" : "", "operationId" : "RO02", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RO02_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List shop roles", "tags" : [ "Users" ] } }, "/api/returns" : { "post" : { "description" : "Limited to 200 returns at a time", "operationId" : "RT01", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT01_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT01_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Create returns", "tags" : [ "Returns" ] }, "put" : { "description" : "", "operationId" : "RT04", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT04_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT04_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Patch update returns", "tags" : [ "Returns" ] }, "get" : { "description" : "", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List returns", "tags" : [ "Returns" ] } }, "/api/returns/items_to_return" : { "get" : { "description" : "", "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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT12_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List items to return", "tags" : [ "Returns" ] } }, "/api/returns/accept" : { "put" : { "description" : "Limited to 100 returns at a time", "operationId" : "RT21", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT21_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT21_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Accept or refuse a return request", "tags" : [ "Returns" ] } }, "/api/returns/receive" : { "put" : { "description" : "Limited to 100 returns at a time", "operationId" : "RT25", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT25_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT25_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Validate returns as received", "tags" : [ "Returns" ] } }, "/api/returns/compliance" : { "put" : { "description" : "Limited to 100 returns at a time", "operationId" : "RT26", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT26_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT26_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Mark a return as compliant or non compliant", "tags" : [ "Returns" ] } }, "/api/returns/close" : { "put" : { "description" : "Limited to 100 returns at a time", "operationId" : "RT27", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT27_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT27_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Mark a return as closed", "tags" : [ "Returns" ] } }, "/api/returns/cancel" : { "put" : { "description" : "Limited to 100 returns at a time", "operationId" : "RT29", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT29_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT29_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Mark a return as canceled", "tags" : [ "Returns" ] } }, "/api/returns/return-labels" : { "post" : { "description" : "Generate return labels for a given list of return IDs", "operationId" : "RT51", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RT51_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT51_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Create return labels", "tags" : [ "Returns" ] }, "get" : { "description" : "Retrieve the list of the return label requests along with their details and states", "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", "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", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Filter labels created on or after the given date.", "explode" : true, "in" : "query", "name" : "date_created_from", "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", "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", "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", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/RT52_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List return labels", "tags" : [ "Returns" ] } }, "/api/shops/documents" : { "get" : { "description" : "You must specify at least one of the following parameters: shop_ids, updated_since", "operationId" : "S30", "parameters" : [ { "description" : "A list of shop identifiers", "explode" : true, "in" : "query", "name" : "shop_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "True to include deleted documents, false to remove them", "explode" : true, "in" : "query", "name" : "include_deleted", "schema" : { "type" : "boolean", "default" : false }, "style" : "form" }, { "description" : "Retrieve shop documents modified at or after this date. The time period cannot exceed 90 days", "explode" : true, "in" : "query", "name" : "updated_since", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/S30_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List shop's documents", "tags" : [ "Stores" ] } }, "/api/shops/documents/download" : { "get" : { "description" : "
    • 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 a list of shop identifiers is specified, all documents from those shops are downloaded.
      Use a list of shop document type codes to retrieve specific types from those shops.
      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|__ shop_id_x/\n|   |__ foo.txt\n|   |__ bar.txt\n|   |__ baz.pdf\n|\n|__ shop_id_y/\n|   |__ image.png\n|   |__ image(1).png\n

    Returns a 404 if at least one document id, one shop id or one document type code is invalid

    ", "operationId" : "S31", "parameters" : [ { "description" : "A list of shop identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids", "explode" : true, "in" : "query", "name" : "shop_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A list of document identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids", "explode" : true, "in" : "query", "name" : "document_ids", "schema" : { "type" : "string" }, "style" : "form" }, { "description" : "A list of document type codes (separated by a comma)", "explode" : true, "in" : "query", "name" : "type_codes", "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Download documents for one or multiple shops", "tags" : [ "Stores" ] } }, "/api/shops/documents/{document_id}" : { "delete" : { "description" : "", "operationId" : "S33", "parameters" : [ { "description" : "Document identifier to delete", "explode" : false, "in" : "path", "name" : "document_id", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "style" : "simple" } ], "responses" : { "204" : { "description" : "No Content" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Delete a shop document", "tags" : [ "Stores" ] } }, "/api/seller-billing-cycles" : { "get" : { "description" : "This resource uses seek pagination. The maximum allowed value for parameter limit is 1000.", "operationId" : "SBC11", "parameters" : [ { "description" : "Currency for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "currency", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Creation date used as the maximum value for filtering (inclusive)", "explode" : true, "in" : "query", "name" : "end_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Seller billing cycle IDs for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "id", "schema" : { "type" : "array", "items" : { "type" : "string", "maxLength" : 36, "minLength" : 36 }, "maxItems" : 100 }, "style" : "form" }, { "description" : "A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.", "explode" : true, "in" : "query", "name" : "pay_out_psp_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Pay-out state for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "pay_out_state", "schema" : { "type" : "array", "default" : [ "TO_PAY", "FAILED", "PAID" ], "items" : { "type" : "string", "default" : "TO_PAY,FAILED,PAID" } }, "style" : "form" }, { "description" : "Payment voucher numbers for filtering. This parameter can be supplied multiple times.", "explode" : true, "in" : "query", "name" : "payment_voucher_number", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Shop ID for filtering. This parameter can be supplied multiple times. Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.", "explode" : true, "in" : "query", "name" : "shop_id", "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "style" : "form" }, { "description" : "Creation date used as the minimum value for filtering (inclusive)", "explode" : true, "in" : "query", "name" : "start_date", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SBC11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List seller billing cycles", "tags" : [ "Invoicing and Accounting" ] } }, "/api/shipping/zones" : { "get" : { "description" : "Results are sorted by index, set in the back-office", "operationId" : "SH11", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SH11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all active shipping zones", "tags" : [ "Platform Settings" ] } }, "/api/shipping/types" : { "get" : { "description" : "Results are sorted by index, set in the back-office", "operationId" : "SH12", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SH12_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : " List all active shipping methods", "tags" : [ "Platform Settings" ] } }, "/api/shipping/carriers" : { "get" : { "description" : "Results are sorted alphabetically by carrier label", "operationId" : "SH21", "parameters" : [ ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SH21_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all carriers", "tags" : [ "Platform Settings" ] } }, "/api/shipping/logistic_classes" : { "get" : { "description" : "Results are sorted by index, set in the back-office", "operationId" : "SH31", "parameters" : [ { "description" : "<ISO-639>_<ISO-3166> (\"en_US\") or <ISO-639> (\"en\") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.", "in" : "query", "name" : "locale", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/SH31_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List all logistic classes", "tags" : [ "Platform Settings" ] } }, "/api/shipments" : { "post" : { "description" : "Limited to 1000 shipments at a time", "operationId" : "ST01", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST01_Request" } } } }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST01_Response_201" } } }, "description" : "Created" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Create shipments", "tags" : [ "Multiple shipments" ] }, "put" : { "description" : "Limited to 100 shipments at a time", "operationId" : "ST07", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST07_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST07_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update shipment shipping origin", "tags" : [ "Multiple shipments" ] }, "get" : { "description" : "", "operationId" : "ST11", "parameters" : [ { "description" : "Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).", "explode" : true, "in" : "query", "name" : "order_id", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Shipment state code for filtering. This parameter can be supplied multiple times (shipment_state_code=SHIPPING&shipment_state_code=SHIPPED...).", "explode" : true, "in" : "query", "name" : "shipment_state_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Shipment customer debit state code for filtering. This parameter can be supplied multiple times (shipment_customer_debit_state_code=WAITING_TAX_CONFIRMATION&shipment_customer_debit_state_code=DEBIT_OK...).", "explode" : true, "in" : "query", "name" : "shipment_customer_debit_state_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Filter shipments updated after the given date.", "explode" : true, "in" : "query", "name" : "last_updated_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter shipments updated before the given date.", "explode" : true, "in" : "query", "name" : "last_updated_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List shipments", "tags" : [ "Multiple shipments" ] } }, "/api/shipments/delete" : { "put" : { "description" : "Limited to 1000 shipments at a time", "operationId" : "ST06", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST06_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST06_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Delete shipments", "tags" : [ "Multiple shipments" ] } }, "/api/shipments/items_to_ship" : { "get" : { "description" : "", "operationId" : "ST12", "parameters" : [ { "description" : "Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).", "explode" : true, "in" : "query", "name" : "order_id", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Fulfillment center code for filtering. This parameter can be supplied multiple times (fulfillment_center_code=ABC&fulfillment_center_code=DEF...).", "explode" : true, "in" : "query", "name" : "fulfillment_center_code", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "style" : "form" }, { "description" : "Filter items that moved to shipping status after the given date.", "explode" : true, "in" : "query", "name" : "shipping_date_from", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Filter items that moved to shipping status before the given date.", "explode" : true, "in" : "query", "name" : "shipping_date_to", "schema" : { "type" : "string", "format" : "date-time" }, "style" : "form" }, { "description" : "Token retrieved from next_page_token or previous_page_token to get to next", "in" : "query", "name" : "page_token", "schema" : { "type" : "string" } }, { "description" : "How the results should be sorted. Must follow \"sort=criterion,direction\" format as described in Mirakl API Documentation", "in" : "query", "name" : "sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST12_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "List items to ship", "tags" : [ "Multiple shipments" ] } }, "/api/shipments/tracking" : { "post" : { "description" : "If the carrier is not registered, the complete tracking url can be provided. Limited to 1000 shipments at a time.", "operationId" : "ST23", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST23_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST23_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update carrier tracking information for shipments", "tags" : [ "Multiple shipments" ] } }, "/api/shipments/ship" : { "put" : { "description" : "Limited to 1000 shipments at a time", "operationId" : "ST24", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST24_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST24_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Validate shipments as shipped", "tags" : [ "Multiple shipments" ] } }, "/api/shipments/ready_for_pick_up" : { "put" : { "description" : "Limited to 1000 shipments at a time", "operationId" : "ST26", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST26_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST26_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Validate shipments as ready to pick up", "tags" : [ "Multiple shipments" ] } }, "/api/shipments/additional_information" : { "put" : { "description" : "Limited to 100 shipments at a time", "operationId" : "ST31", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ST31_Request" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/ST31_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Update shipment additional information", "tags" : [ "Multiple shipments" ] } }, "/api/offers/stock/imports" : { "post" : { "description" : "Import a .csv file to update stock for offers, either globally or per warehouse.
    \nReturns an import identifier to track the status of the import and retrieve an error report if applicable.
    \n", "operationId" : "STO01", "parameters" : [ ], "requestBody" : { "content" : { "multipart/form-data" : { "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" }, "shop_id" : { "type" : "integer", "format" : "int64", "description" : "Shop Identifier" } } } } } }, "responses" : { "201" : { "content" : { "application/json" : { "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" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Import a stock file", "tags" : [ "Offers" ] } }, "/api/offers/stock/imports/{import_id}/status" : { "get" : { "description" : "", "operationId" : "STO02", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/STO02_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get information and statistics about an offer stock import", "tags" : [ "Offers" ] } }, "/api/offers/stock/imports/{import_id}/error_report" : { "get" : { "description" : "Only 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", "operationId" : "STO03", "parameters" : [ { "description" : "Import identifier", "explode" : false, "in" : "path", "name" : "import_id", "required" : true, "schema" : { "type" : "string" }, "style" : "simple" } ], "responses" : { "200" : { "content" : { "text/csv" : { "schema" : { "type" : "string", "format" : "binary" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "Get the error report for a stock import in CSV format", "tags" : [ "Offers" ] } }, "/api/values_lists" : { "get" : { "description" : "", "operationId" : "VL11", "parameters" : [ { "description" : "The operator's values list code. If not specified, all values lists are retrieved", "explode" : true, "in" : "query", "name" : "code", "schema" : { "type" : "string" }, "style" : "form" } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "object", "$ref" : "#/components/schemas/VL11_Response_200" } } }, "description" : "OK" } }, "security" : [ { "Operator-Bearer-Token" : [ ] }, { "OAuth-2" : [ ] } ], "summary" : "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 }