swagger: '2.0'
info:
  description: Microservice for transfering ICM orders to Microsoft systems.
  version: 1.0.0
  title: Order Submission Service
  contact:
    name: Intershop Communications
    url: 'https://support.intershop.de/'
    email: support@intershop.de
basePath: /orderSubmission
tags:
  - name: Order Submission Service - V1
schemes:
  - http
  - https
paths:
  /orders:
    post:
      tags:
        - Order Submission Service - V1
      summary: Submits a given order to the service.
      description: ''
      operationId: processOrder
      produces:
        - application/vnd.intershop.ordersubmission.V1+json
      parameters:
        - in: body
          name: body
          description: The order.
          required: false
          schema:
            $ref: '#/definitions/OrderSubmissionRO'
      responses:
        default:
          description: successful operation
definitions:
  AddressRO:
    type: object
    required:
      - addressLine1
      - city
      - contact
      - countryCode
      - postalCode
    properties:
      addressLine1:
        type: string
        example: Sample Street 1a
        description: 'The first address line, that usual contains street and house number.'
      city:
        type: string
        example: Sample City
        description: The name of the local authority district.
      countryCode:
        type: string
        example: US
        description: The ISO 3166 (ALPHA2) country code.
      postalCode:
        type: string
        example: '77093'
        description: The code of letters and digits used as part of a postal address to aid the sorting of mail. Also called (in Britain and certain other countries) postcode US equivalent zip code.
      contact:
        description: The contact data.
        $ref: '#/definitions/ContactRO'
      addressType:
        type: string
        example: POSTAL
        description: The address type describes the nature and intended use of the given address.
        enum:
          - POSTAL
          - DIGITAL
          - STORE
      addressLine2:
        type: string
        example: Northern University
        description: The second address line. This line is optional if room is needed to include more identifying information than a simple street and house number.
      addressLine3:
        type: string
        example: Floor 3
        description: The third address line. This line is optional if room is needed to include additional information.
      postBox:
        type: string
        example: '143'
        description: The number of a post office box (commonly referred to as a PO box or a postal box).
      mainDivision:
        type: string
        example: Texas
        description: 'The main division of the country, e.g., state or province.'
      subDivision:
        type: string
        example: Harris County
        description: 'The sub division of the main division, e.g., county or prefecture.'
      additionalAttributes:
        type: array
        description: Additional attributes specified for the address.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Provides details about a address.
  AttributeRO:
    type: object
    discriminator: type
    properties:
      name:
        type: string
        example: someAttribute
        description: The attribute's name
      value:
        type: object
        example: 'true'
        description: The attribute's value.
      type:
        type: string
        example: BOOLEAN
        description: The attribute's type.
        enum:
          - BOOLEAN
          - DATE
          - DECIMAL
          - DOUBLE
          - INTEGER
          - LONG
          - MONEY
          - QUANTITY
          - STRING
          - TEXT
    description: Base type for an attribute (key-value pair).
  AttributeROObject:
    type: object
    properties:
      name:
        type: string
        example: someAttribute
        description: The attribute's name
      value:
        type: object
        example: 'true'
        description: The attribute's value.
      type:
        type: string
        example: BOOLEAN
        description: The attribute's type.
        enum:
          - BOOLEAN
          - DATE
          - DECIMAL
          - DOUBLE
          - INTEGER
          - LONG
          - MONEY
          - QUANTITY
          - STRING
          - TEXT
    description: Base type for an attribute (key-value pair).
  BooleanAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: boolean
            example: true
            description: The attribute value of type Boolean.
            readOnly: true
            enum:
              - true
              - false
          type:
            type: string
            example: BOOLEAN
            description: The attribute type.
            enum:
              - BOOLEAN
        description: An attribute with a value of the type Boolean.
  BucketRO:
    type: object
    required:
      - bucketTotals
      - items
      - shipToAddress
      - shippingMethod
    properties:
      shipToAddress:
        description: The ship-to address of the bucket.
        $ref: '#/definitions/AddressRO'
      shippingMethod:
        description: The shipping method of the bucket.
        $ref: '#/definitions/ShippingMethodRO'
      items:
        type: array
        description: The items of the bucket.
        items:
          $ref: '#/definitions/ItemRO'
      bucketTotals:
        description: The totals of the bucket.
        $ref: '#/definitions/BucketTotalsRO'
      shippingInstructions:
        type: string
        example: Handle with care!
        description: The shipping instructions for this shipping bucket.
      bucketDiscounts:
        type: array
        description: The bucket discounts for this shipping bucket.
        items:
          $ref: '#/definitions/DiscountRO'
    description: Describes a shipping bucket.
  BucketTotalsRO:
    type: object
    properties:
      shippingDiscountsTotal:
        description: The totals of the bucket discounts.
        $ref: '#/definitions/PriceRO'
    description: Describes the bucket totals.
  BuyerRO:
    allOf:
      - $ref: '#/definitions/RoleRO'
      - type: object
        required:
          - contact
        properties:
          contact:
            description: The contact data.
            $ref: '#/definitions/ContactRO'
          department:
            type: string
            example: Procurement
            description: The department the buyer is assigned to.
          gender:
            type: string
            example: FEMALE
            description: Buyer's gender.
            enum:
              - MALE
              - FEMALE
          dateOfBirth:
            type: string
            example: '1989-07-11'
            description: Buyer's date of birth.
          accountId:
            type: string
            example: patricia.miller@test.intershop.de
            description: Buyer's account ID.
          socialSecurityNumber:
            type: string
            description: Buyer's social security number.
        description: Describes a business partner holding the role BUYER
  ContactRO:
    type: object
    required:
      - firstName
      - lastName
    properties:
      firstName:
        type: string
        example: Peter
        description: 'The given name (also known as a personal name, first name, forename, or Christian name) of the contact person.'
      lastName:
        type: string
        example: Sampleman
        description: 'The surname (also known as a family name, last name, or gentile name) of the contact person.'
      title:
        type: string
        example: Lord
        description: 'The title of the contact person, that is an aristocratic title, like Lord or Lady, in the most cases.'
      aristocraticTitle:
        type: string
        example: Mr
        description: 'The personal title, like Ms., Mr.'
      honorific:
        type: string
        example: PhD
        description: 'The honorific title of the contact person, that denotes the honored person''s occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD.'
      jobTitle:
        type: string
        example: Procurement Lead
        description: The job title of the contact person.
      secondName:
        type: string
        example: Max
        description: 'The second given name of the contact person. Allocation depends on the culture area, in European countries this would be regarded as the second name, whereas in United States a person has usually one middle name.'
      secondLastName:
        type: string
        example: Rodriguez
        description: 'The second last name of the contact person. Allocation depends on the culture area, second last (sur-) name is common in Hispanic culture.'
      phoneHome:
        type: string
        example: +49 (3641) 123456
        description: The phone number of the house or apartment where the contact person lives.
      phoneMobile:
        type: string
        example: +49 (165) 5673123
        description: The number of contact person's cell phone.
      phoneBusiness:
        type: string
        example: +49 (3641) 50-0
        description: The number of contact person's company.
      phoneBusinessDirect:
        type: string
        example: '3479'
        description: Business phone number extension that allows an outside caller to connect directly to the contact person without any help of an attendant or operator.
      fax:
        type: string
        example: +49 (3641) 50-1344
        description: The number of contact persons for facsimile machine.
      email:
        type: string
        example: peter.sampleman@intershop.de
        description: Contact person's e-mail account.
    description: Provides details about a contact person.
  CustomerRO:
    type: object
    required:
      - customerNo
      - customerTypeId
      - customerUrn
      - roles
    properties:
      customerNo:
        type: string
        example: OilCorp
        description: ID uniquely identifying the customer in the context of the store.
      customerUrn:
        type: string
        example: 'urn:customer:ICM:inSPIRED:inTOOLS:OilCorp'
        description: URN representation of the customer in the INTERSCHOP system.
      externalCustomerNo:
        type: string
        example: '000123456'
        description: ID uniquely identifying the customer in an external system; required only for registered customers that have already been synchronized with an appropriate external system
      externalCustomerUrn:
        type: string
        example: 'urn:customer:MSDynamics365:MyCorp:0033459'
        description: URN representation of the customer in an external system; required only for registered customers that have already been synchronized with an appropriate external system
      customerTypeId:
        type: string
        example: PRIVATE
        description: The customer type ID.
        enum:
          - PRIVATE
          - SMB
      companyName1:
        type: string
        example: OilCorp Ltd.
        description: First part of customer's company name; for business customers only.
      companyName2:
        type: string
        example: OilCorp Corporate Headquarters
        description: Second part of customer's company name; for business customers only.
      taxationId:
        type: string
        example: 9XX-78-XXXX
        description: Customer's tax number.
      roles:
        type: array
        description: The business partners involved in the checkout process.
        items:
          $ref: '#/definitions/RoleRO'
      additionalAttributes:
        type: array
        description: Additional attributes specified for the customer.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Provides details about a customer.
  DateAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: string
            example: '1989-07-11'
            description: The attribute value of type Date.
            readOnly: true
          type:
            type: string
            example: DATE
            description: The attribute type.
            enum:
              - DATE
        description: An attribute with a value of the type Date.
  DecimalAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: number
            example: 1234.45
            description: The attribute value of type DECIMAL.
            readOnly: true
          type:
            type: string
            example: DECIMAL
            description: The attribute type.
            enum:
              - DECIMAL
        description: An attribute with a value of the type DECIMAL.
  DiscountRO:
    type: object
    properties:
      id:
        type: string
        example: 92YKAM6dZtIAAAFb_KwtfPFU
        description: The ID of the promotion that triggered the discount.
      promotionType:
        type: string
        example: Order Value Off
        description: The promotion action type.
      description:
        type: string
        example: 20 USD Order discount
        description: The localized promotion description.
      code:
        type: string
        example: Intershop
        description: The used promotion code.
      amount:
        description: The amount of the applied rebate granted to the parent object.
        $ref: '#/definitions/PriceRO'
    description: Describes a discount arising from an applied promotion.
  DocumentInfoRO:
    type: object
    required:
      - currency
      - documentNo
      - locale
      - orderUrn
      - store
    properties:
      orderUrn:
        type: string
        example: 'urn:order:ICM:inSPIRED:inTRONICS:00000002'
        description: URN representation of the order in an Intershop system.
      documentNo:
        type: string
        example: '00000002'
        description: Order document number uniquely identifying the order in the context of the store.
      store:
        type: string
        example: inTRONICS
        description: Identifier of the store where the order has been placed.
      currency:
        type: string
        example: USD
        description: The currency used for calculating prices and costs of the order (ISO 4217).
      locale:
        type: string
        example: en_US
        description: The locale the business partner used during the checkout process.
      customerReferenceId:
        type: string
        example: RE201700002786598
        description: Any custom reference ID of the order that can be specified by the buyer during the checkout process. An example would be a reference number existing in one of buyer's backend systems.
      costCenter:
        type: string
        example: '100400'
        description: Customer's cost center the order should be assigned too.
      costCenterName:
        type: string
        example: Oil Corp Headquarter
        description: Name of customer's cost center the order should be assigned too.
      messageToMerchant:
        type: string
        example: Is it possible to send the ordered articles before Christmas?
        description: Something what the buyer would like to tell the merchant.
    description: Provides information about an order document.
  DoubleAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: number
            format: double
            example: 123.456
            description: The attribute value of type Double.
            readOnly: true
          type:
            type: string
            example: DOUBLE
            description: The attribute type.
            enum:
              - DOUBLE
        description: An attribute with a value of the type Double.
  GiftMessageRO:
    type: object
    properties:
      product:
        description: The Product representing the gift message.
        $ref: '#/definitions/ProductRO'
      itemPricing:
        description: Details about sales and shipping pricing for the Item.
        $ref: '#/definitions/ItemPricingRO'
      message:
        type: string
        example: Happy birthday!
        description: The text of the gift message.
      from:
        type: string
        example: Patricia
        description: The name of the granter of the gift message.
      to:
        type: string
        example: Peter
        description: The name of the receiver of the gift message.
    description: Describes a gift messages assigned to the line item.
  GiftWrapRO:
    type: object
    properties:
      product:
        description: The Product representing the gift wrap.
        $ref: '#/definitions/ProductRO'
      itemPricing:
        description: Details about sales and shipping pricing for the Item.
        $ref: '#/definitions/ItemPricingRO'
    description: Describes a gift wrap assigned to the line item.
  HeaderRO:
    type: object
    required:
      - documentInfo
      - processInfo
    properties:
      documentInfo:
        description: Information about the processing status of the order.
        $ref: '#/definitions/DocumentInfoRO'
      processInfo:
        description: General information about the order document.
        $ref: '#/definitions/ProcessInfoRO'
    description: Describes general order document and processing data.
  IntegerAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: integer
            format: int32
            example: 1234
            description: The attribute value of type Integer.
            readOnly: true
          type:
            type: string
            example: INTEGER
            description: The attribute type.
            enum:
              - INTEGER
        description: An attribute with a value of the type Integer.
  ItemPricingRO:
    type: object
    properties:
      salesPricing:
        description: Details about the sales pricing of the Item.
        $ref: '#/definitions/SalesPricingRO'
      shippingPricing:
        description: Details about the shipping and handling costs for the Item.
        $ref: '#/definitions/ShippingPricingRO'
      surcharges:
        description: Details about additional surcharges applied to the Item.
        $ref: '#/definitions/SurchargesRO'
    description: Describes sales and shipping pricing details for the Item.
  ItemProductRO:
    type: object
    properties:
      id:
        type: string
        example: 5079747@inSPIRED-inTRONICS
        description: The ID identifying product uniquely throughout entire communication.
      sku:
        type: string
        example: '5079747'
        description: The stock keeping unit (SKU) of the product.
      name:
        type: string
        example: InTRONICS IS-25Y Portable
        description: The product's name.
      additionalAttributes:
        type: array
        description: Additional attributes specified for the Product.
        items:
          $ref: '#/definitions/AttributeROObject'
      isGiftCard:
        type: boolean
        example: true
        description: 'True if Item represents a gift card, false otherwise.'
        enum:
          - true
          - false
      isDigital:
        type: boolean
        example: false
        description: 'True if Item represents a digital good, false otherwise.'
        enum:
          - true
          - false
    description: Describes a product representing the line item.
  ItemRO:
    type: object
    properties:
      lineItem:
        description: 'Details about the line item, like line item position, quantity, etc.'
        $ref: '#/definitions/LineItemRO'
      itemProduct:
        description: The Product assigned to the Item.
        $ref: '#/definitions/ItemProductRO'
      itemPricing:
        description: Details about the Item pricing.
        $ref: '#/definitions/ItemPricingRO'
      itemGiftWrap:
        description: Details about the gift wrapping for line item's products.
        $ref: '#/definitions/GiftWrapRO'
      itemGiftMessage:
        description: Details about the gift message that has been added to the line item.
        $ref: '#/definitions/GiftMessageRO'
      itemWarranty:
        description: Details about warranties assigned to the Item.
        $ref: '#/definitions/WarrantyRO'
      additionalAttributes:
        type: array
        description: Additional attributes specified for the item.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Describes an item contained in a bucket.
  JurisdictionRO:
    type: object
    properties:
      id:
        type: string
        example: CANADA
        description: The jurisdiction ID.
      level:
        type: string
        example: COUNTRY
        description: The level of the jurisdiction for which the tax is applied.
        enum:
          - APO
          - BOROUGH
          - CITY
          - COUNTRY
          - COUNTY
          - DISTRICT
          - FPO
          - LOCAL_IMPROVEMENT_DISTRICT
          - PARISH
          - PROVINCE
          - SPECIAL_PURPOSE_DISTRICT
          - STATE
          - TERRITORY
          - TOWNSHIP
          - TRADE_BLOCK
          - TRANSIT_DISTRICT
    description: 'Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.'
  LineItemRO:
    type: object
    properties:
      position:
        type: integer
        format: int32
        description: The position of the Item in the basket or the order.
      quantity:
        description: The quantity of the Item.
        $ref: '#/definitions/QuantityRO'
      desiredDeliveryDate:
        type: string
        example: '2018-12-20'
        description: The desired delivery date for the Item.
    description: Describes a line item of a basket or an order.
  LongAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: integer
            format: int64
            example: 1234567890
            description: The attribute value of type Long.
            readOnly: true
          type:
            type: string
            example: LONG
            description: The attribute type.
            enum:
              - LONG
        description: An attribute with a value of the type Long.
  MoneyAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            description: The attribute value of type Money.
            readOnly: true
            $ref: '#/definitions/MoneyRO'
          type:
            type: string
            example: MONEY
            description: The attribute type.
            enum:
              - MONEY
        description: An attribute with a value of the type Money.
  MoneyRO:
    type: object
    required:
      - currency
      - value
    properties:
      currency:
        type: string
        example: USD
        description: Three-letter currency code (ISO 4217) of the monetary value.
        readOnly: true
      value:
        type: number
        example: 10.99
        description: The monetary value.
        readOnly: true
    description: Describes a money object.
  OrderDiscountsRO:
    type: object
    properties:
      orderValueDiscounts:
        type: array
        description: All discounts granted on the order total.
        items:
          $ref: '#/definitions/DiscountRO'
      orderShippingDiscounts:
        type: array
        description: All discounts granted on shipping and handling costs.
        items:
          $ref: '#/definitions/DiscountRO'
    description: Provides details about the applied discounts on basket/order level.
  OrderRO:
    type: object
    required:
      - buckets
      - header
      - invoiceToAddress
      - payments
      - totals
    properties:
      header:
        description: General information about the order.
        $ref: '#/definitions/HeaderRO'
      totals:
        description: The order totals.
        $ref: '#/definitions/TotalsRO'
      invoiceToAddress:
        description: The invoice-to address of the order.
        $ref: '#/definitions/AddressRO'
      buckets:
        type: array
        description: The shipping buckets of the order.
        items:
          $ref: '#/definitions/BucketRO'
      payments:
        type: array
        description: The payments used to pay the order.
        items:
          $ref: '#/definitions/PaymentRO'
      customer:
        description: The customer who placed the order. Note that customer is not specified in case of unregistered checkout!
        $ref: '#/definitions/CustomerRO'
      orderDiscounts:
        description: The discounts applied to the order totals.
        $ref: '#/definitions/OrderDiscountsRO'
      additionalAttributes:
        type: array
        description: Additional attributes specified for the order.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Describes an order.
  OrderSubmissionRO:
    type: object
    required:
      - callbackUri
      - order
    properties:
      order:
        description: The order to be submitted to the backend system.
        $ref: '#/definitions/OrderRO'
      callbackUri:
        type: string
        example: 'service://order-service/v1/orders/urn:order:ICM:inSPIRED:inTRONICS:00000002'
        description: The callback URI to be called after the order is created in the backend system.
  PaymentRO:
    type: object
    required:
      - id
      - limitedTender
      - paymentBaseAmount
      - paymentCost
      - paymentTotalAmount
      - status
    properties:
      id:
        type: string
        example: ISH_INVOICE
        description: The ID of the payment method.
      limitedTender:
        type: boolean
        example: true
        description: Whether the payment represents a limited tender.
        enum:
          - true
          - false
      paymentBaseAmount:
        description: The base amount of the payment (i. e. the amount which the payment costs are determined for).
        $ref: '#/definitions/MoneyRO'
      paymentTotalAmount:
        description: The total amount of the payment (i. e. base amount plus payment costs).
        $ref: '#/definitions/MoneyRO'
      status:
        type: string
        example: CREATED
        description: The status of the payment.
      paymentCost:
        description: The costs of the payment.
        $ref: '#/definitions/PriceRO'
      paymentTaxes:
        type: array
        description: The payment taxes of this payment.
        items:
          $ref: '#/definitions/TaxItemRO'
      additionalAttributes:
        type: array
        description: Additional attributes specified for the payment.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Describes a payment.
  PriceRO:
    type: object
    required:
      - gross
      - net
    properties:
      net:
        description: The net value.
        $ref: '#/definitions/MoneyRO'
      gross:
        description: The gross value.
        $ref: '#/definitions/MoneyRO'
      tax:
        description: The tax value.
        $ref: '#/definitions/MoneyRO'
    description: 'Describes a price. A price has a monetary net, gross and tax value.'
  ProcessInfoRO:
    type: object
    required:
      - creationDate
      - status
    properties:
      status:
        type: string
        description: Processing the status of the order.
        enum:
          - CANCELLED
          - CANCELLEDANDEXPORTED
          - COMPLETED
          - CREATED
          - DELIVERED
          - EXPORTFAILED
          - INPROGRESS
          - MANUAL_INTERVENTION_NEEDED
          - NEW
          - NOTDELIVERABLE
          - OPEN
          - PAYMENTCANCELLED
          - PENDING
          - REJECTED
          - RETURNED
      creationDate:
        type: string
        example: '2001-07-04T12:08:56.235-07:00'
        description: 'The date, the order has been placed.'
      subscriptionNo:
        type: string
        example: 00975-9C1
        description: The document no of the subscription if the order is triggered by a subscription.
    description: Describes the processing state of the order.
  ProductRO:
    type: object
    properties:
      id:
        type: string
        example: 5079747@inSPIRED-inTRONICS
        description: The ID identifying product uniquely throughout entire communication.
      sku:
        type: string
        example: '5079747'
        description: The stock keeping unit (SKU) of the product.
      name:
        type: string
        example: InTRONICS IS-25Y Portable
        description: The product's name.
      additionalAttributes:
        type: array
        description: Additional attributes specified for the Product.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Descibes a product.
  QuantityAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            description: The attribute value of type Quantity.
            readOnly: true
            $ref: '#/definitions/QuantityRO'
          type:
            type: string
            example: QUANTITY
            description: The attribute type.
            enum:
              - QUANTITY
        description: An attribute with a value of the type Quantity.
  QuantityRO:
    type: object
    required:
      - unit
      - value
    properties:
      unit:
        type: string
        example: PIEC
        description: The quantity's ISO unit code.
        readOnly: true
      value:
        type: number
        example: 10.99
        description: The quantity's value.
        readOnly: true
    description: Quantity combines a quantity value and the ISO unit code the value is defined in.
  RoleRO:
    type: object
    discriminator: role
    properties:
      role:
        type: string
        example: BUYER
        description: Role of the business partner in the checkout process.
        enum:
          - BUYER
      additionalAttributes:
        type: array
        description: Additional attributes specified for this role.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Base type for business partners.
  SalesPricingRO:
    type: object
    properties:
      price:
        description: The price without any granted item discounts.
        $ref: '#/definitions/PriceRO'
      singleBasePrice:
        description: The price of a single unit without any applied value discounts.
        $ref: '#/definitions/PriceRO'
      itemValueDiscounts:
        type: array
        description: All discounts granted on the sales price.
        items:
          $ref: '#/definitions/DiscountRO'
      itemValueDiscountsTotal:
        description: The total of all value discounts of the item.
        $ref: '#/definitions/PriceRO'
      taxes:
        type: array
        description: All taxes applied to the net price.
        items:
          $ref: '#/definitions/TaxItemRO'
      discountedSingleBasePrice:
        description: The price of a single unit with all applied value discounts.
        $ref: '#/definitions/PriceRO'
      discountedSingleBasePriceRemainder:
        description: The remainder resulting from splitting order discounts to item's single base prices.
        $ref: '#/definitions/PriceRO'
      discountedPrice:
        description: The price of the line item with all applied item value discounts.
        $ref: '#/definitions/PriceRO'
    description: 'Describes sales pricing details for Item, GiftMessage, GiftWrap, Warranty.'
  ShippingMethodRO:
    type: object
    required:
      - id
    properties:
      id:
        type: string
        example: STD_GROUND
        description: The id of the shipping method.
      name:
        type: string
        example: STANDARD GROUND
        description: The localized name of the shipping method.
      additionalAttributes:
        type: array
        description: Additional attributes specified for this shipping method.
        items:
          $ref: '#/definitions/AttributeROObject'
    description: Provides details about a shipping method.
  ShippingPricingRO:
    type: object
    properties:
      shippingTotal:
        description: The total for shipping and handling of the Item.
        $ref: '#/definitions/PriceRO'
      itemShippingDiscounts:
        type: array
        description: All discounts granted on shipping and handling costs.
        items:
          $ref: '#/definitions/DiscountRO'
      itemShippingDiscountsTotal:
        description: The total of all shipping discounts of the item.
        $ref: '#/definitions/PriceRO'
      taxes:
        type: array
        description: All taxes applied to the shipping and handling costs.
        items:
          $ref: '#/definitions/TaxItemRO'
    description: Describes shipping pricing details for an Item.
  StringAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: string
            example: a string value
            description: The attribute value of type String.
            readOnly: true
          type:
            type: string
            example: STRING
            description: The attribute type.
            enum:
              - STRING
        description: An attribute with a value of the type String.
  SurchargeRO:
    type: object
    required:
      - amount
      - name
    properties:
      amount:
        description: The surcharge's amount.
        $ref: '#/definitions/PriceRO'
      name:
        type: string
        example: Fridge Box
        description: The surcharge's localized name.
      description:
        type: string
        example: Needs a fridge box for shipping.
        description: The surcharge's localized description.
      taxes:
        type: array
        description: The taxes applied to the surcharge.
        items:
          $ref: '#/definitions/TaxItemRO'
    description: Describes a single surcharge incurred to a shipping bucket.
  SurchargesRO:
    type: object
    properties:
      itemSurcharges:
        type: array
        description: All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
        items:
          $ref: '#/definitions/SurchargeRO'
      itemImportSurcharges:
        type: array
        description: All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item - import'.
        items:
          $ref: '#/definitions/SurchargeRO'
      itemSurchargesTotal:
        description: The total of all item based extra charges arising from surcharges directly specified on product or by shipping rules with action types 'item' and 'item - import'.
        $ref: '#/definitions/PriceRO'
      distributedBucketSurcharges:
        type: array
        description: The percentage shares of all surcharges specified for the bucket this line item is contained in. These shares are arising from surcharges created by shipping rules with action type 'bucket'.
        items:
          $ref: '#/definitions/SurchargeRO'
      distributedBucketSurchargesTotal:
        description: The total of the percentage shares of all surcharges levied on the bucket this line item is contained in. These shares are arising from surcharges created by shipping rules with action type 'bucket'.
        $ref: '#/definitions/PriceRO'
      surchargesTotal:
        description: 'The net total of all surcharges levied on this line item, containing surcharge types ''item'', ''item -import'' and ''bucket''.'
        $ref: '#/definitions/PriceRO'
    description: ' Details about additional surcharges arising from shipping, handling and import fees.'
  TaxItemRO:
    type: object
    properties:
      calculatedTax:
        description: The calculated tax amount.
        $ref: '#/definitions/MoneyRO'
      effectiveTaxRate:
        type: number
        description: The effective rate used to calculate the tax.
      situs:
        type: string
        example: DESTINATION
        description: The situs/place of taxation.
        enum:
          - 'NULL'
          - ADMINISTRATIVE_DESTINATION
          - ADMINISTRATIVE_ORIGIN
          - DESTINATION
          - ORIGIN
      jurisdiction:
        description: 'The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country.'
        $ref: '#/definitions/JurisdictionRO'
      nonTaxableAmount:
        description: 'The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes.'
        $ref: '#/definitions/MoneyRO'
      taxableAmount:
        description: 'The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax.'
        $ref: '#/definitions/MoneyRO'
    description: Represents a single tax item.
  TextAttributeRO:
    allOf:
      - $ref: '#/definitions/AttributeRO'
      - type: object
        properties:
          name:
            type: string
            example: someAttribute
            description: The attribute's name
            readOnly: true
          value:
            type: string
            example: 'Lorem ipsum dolor sit amet, ...'
            description: The attribute value of type Text.
            readOnly: true
          type:
            type: string
            example: TEXT
            description: The attribute type.
            enum:
              - TEXT
        description: An attribute with a value of type Text.
  TotalsRO:
    type: object
    required:
      - grandTotal
      - itemTotal
      - shippingTotal
    properties:
      grandTotal:
        description: Grand total order value (i. e. what the buyer has to pay).
        $ref: '#/definitions/PriceRO'
      itemTotal:
        description: Accumulated line item totals of the order without any discounts.
        $ref: '#/definitions/PriceRO'
      shippingTotal:
        description: Accumulated shipping costs of the order without any discounts.
        $ref: '#/definitions/PriceRO'
      discountedItemTotal:
        description: 'Accumulated line item totals of the order, containing discounts of applied rebates.'
        $ref: '#/definitions/PriceRO'
      discountedShippingTotal:
        description: 'Accumulated shipping costs of the order, containing discounts of applied rebates.'
        $ref: '#/definitions/PriceRO'
      discountTotal:
        description: Accumulated discounts amounts of the order.
        $ref: '#/definitions/PriceRO'
      giftingTotal:
        description: Order's gifting totals.
        $ref: '#/definitions/PriceRO'
      surchargeTotal:
        description: Order's surcharge totals.
        $ref: '#/definitions/PriceRO'
      itemValueDiscountsTotal:
        description: Order's totals of all item level value discounts (excluding any shipping discounts).
        $ref: '#/definitions/PriceRO'
      itemShippingDiscountsTotal:
        description: Order's totals of all item level shipping discounts.
        $ref: '#/definitions/PriceRO'
      bucketShippingDiscountsTotal:
        description: Order's totals of all bucket level shipping discounts.
        $ref: '#/definitions/PriceRO'
      orderValueDiscountsTotal:
        description: Order's totals of all order level value discounts.
        $ref: '#/definitions/PriceRO'
      orderShippingDiscountsTotal:
        description: Order's totals of all order level shipping discounts.
        $ref: '#/definitions/PriceRO'
      valueDiscountsTotal:
        description: Order's totals of all value discounts.
        $ref: '#/definitions/PriceRO'
      shippingDiscountsTotal:
        description: Order's totals of all shipping discounts.
        $ref: '#/definitions/PriceRO'
      salesTaxTotalsByTaxRate:
        type: array
        description: 'All sales taxes applied to the order, accumulated by their tax rates.'
        items:
          $ref: '#/definitions/TaxItemRO'
      shippingTaxTotalsByTaxRate:
        type: array
        description: 'All shipping taxes applied to the order, accumulated by their tax rates.'
        items:
          $ref: '#/definitions/TaxItemRO'
      taxTotalsByTaxRate:
        type: array
        description: 'All taxes applied to the order, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.'
        items:
          $ref: '#/definitions/TaxItemRO'
    description: Describes the order totals.
  WarrantyRO:
    type: object
    properties:
      product:
        description: The Product representing the warranty.
        $ref: '#/definitions/ProductRO'
      itemPricing:
        description: Details about sales and shipping pricing for the Item.
        $ref: '#/definitions/ItemPricingRO'
    description: Describes a warranty assigned to the line item.