openapi: 3.0.1
info:
  title: Order IOM Extension
  description: "The Order IOM Extension REST API, provided by the IOM Connector, introduces\
    \ IOM-specific resources\nthat extend the capabilities of the standard Order REST\
    \ API.  \nTo make use of these extensions, it is crucial to have the IOM Connector\
    \ customization correctly installed and configured.\n\n## API Versioning & Accept-Header\n\
    \nMedia type based versioning is used to distinguish between different API versions.\
    \ \nFor requests to the _Order IOM Extension REST API v1_, the REST client must\
    \ set the following HTTP ```Accept``` header:\n\n```Accept: application/vnd.intershop.order-iom-ext.v1+json```\n\
    \n## Order API resource objects extensions\n\nIf the IOM Connector is installed,\
    \ it also extends the standard Order REST API with the following attributes:\n\
    \n### IOMPaymentStatus in OrderRO:\nThe `IOMPaymentStatus` object represents the\
    \ payment status of the order. It includes the following properties:\n- paidAmount:\
    \ An object that represents the amount that has been paid for the order\n  - currency\
    \ (string): The currency of the paidAmount\n  - value (number): The value of the\
    \ paidAmount\n- paidAmountPercent (number): The percentage of the order amount\
    \ that has been paid\n- paymentStatus (string): The status of the payment for\
    \ the order (e.g., \"Paid\")\n- remainingAmount: An object that represents the\
    \ remaining amount to be paid for the order\n  - currency (string): The currency\
    \ of the remainingAmount\n  - value (number): The value of the remainingAmount\n\
    - remainingAmountPercent (number): The percentage of the order amount that is\
    \ remaining to be paid\n\nExample:\n```json\n\"IOMPaymentStatus\": {\n\t\"paidAmount\"\
    : {\n\t\t\"currency\": \"USD\",\n\t\t\"value\": 789.00\n\t},\n\t\"paidAmountPercent\"\
    : 100,\n\t\"paymentStatus\": \"Paid\",\n\t\"remainingAmount\": {\n\t\t\"currency\"\
    : \"USD\",\n\t\t\"value\": 0.00\n\t},\n\t\"remainingAmountPercent\": 0\n}\n```\n\
    \n### IOMShippingStatus in OrderLineItemRO:\nThe `IOMShippingStatus` object represents\
    \ the shipping status of the order line item. It includes the following properties:\n\
    - name (string): The name of the shipping carrier\n- packages (integer($int32)):\
    \ The number of packages associated with the shipping carrier\n- trackingNumbers\
    \ (string[]): An array of tracking numbers associated with the shipping carrier\n\
    \nExample:\n```json\n\"IOMShippingStatus\": [\n\t{\n\t\t\"name\": \"STD_GROUND\"\
    ,\n\t\t\"packages\": 1,\n\t\t\"trackingNumbers\": [\n\t\t\t\"4454545454242\"\n\
    \t\t]\n\t}\n]\n```\n\n## Changelog\n- - -\n### Version 1.0.1\n- added documentation\
    \ about Order API resource objects extensions\n- adapt documentation for Key Features\
    \ section\n- added status codes for Document requests\n\n### Version 1.0.0\n**Initial\
    \ Release** \n\n#### Key Features:\n- **Order-Related Documents**\n    - Provides\
    \ resources for listing and accessing various order-related documents.\n    -\
    \ Allows downloading PDF versions of specific documents.\n\n- **Return Requests\
    \ for Orders**\n    - Provides resources for listing returnable order positions.\n\
    \    - Supports the creation of new return requests for one or more order positions.\n\
    \    - Offers endpoints for listing return requests for a given order, their positions,\
    \ and custom-attributes.\n\n"
  contact:
    name: Intershop Communications AG
    url: http://intershop.com
  version: 1.0.1
servers:
- url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}"
  description: Intershop ICM Server
  variables:
    serverGroup:
      description: The server group
      default: WFS
    siteName:
      description: The site name
      default: inSPIRED-inTRONICS-Site
    appUrl:
      description: The application URL identifier
      default: "-"
      enum:
      - "-"
      - "-"
      - "-"
tags:
- name: Document
  description: "This section covers requests for accessing order-related documents\
    \ provided by the IOM. \nThe requests require a properly configured and enabled\
    \ IOM Order History Service."
  x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource
- name: Return Reason
  description: "This section covers the retrieval of possible return reasons. \nRequests\
    \ in this section require a properly configured and enabled IOM RMA Service. \n\
    The requests are forwarded directly to the configured IOM, which must support\
    \ the IOM RMA API 2.10 or later for all features to be fully available."
  x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource
- name: Return Request
  description: "This section covers requests for managing return requests. \nThis\
    \ includes retrieving a list of returnable positions, of return requests of an\
    \ order, of custom attributes as well as the creation of return requests. \nRequests\
    \ in this section require a properly configured and enabled IOM RMA Service. \n\
    The requests are forwarded directly to the configured IOM, which must support\
    \ the IOM RMA API 2.12 or later for all features to be fully available. \nIf the\
    \ IOM used only supports RMA API version 2.11 or 2.10, certain resources will\
    \ not be available and the corresponding request will return the HTTP status 404\
    \ (Not Found). \nFurther details can be found in the description and changelog\
    \ of the [IOM RMA REST API](https://support.intershop.com/kb/2G9423)."
  x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource
paths:
  /orders/return-reasons:
    get:
      tags:
      - Return Reason
      summary: Returns the return reasons
      description: This operation returns a list of the configured return reasons.
      operationId: getShop2ReturnReasons
      parameters:
      - name: type
        in: query
        description: Returns the return reasons by name of 1..n return types
        schema:
          type: array
          description: Returns the return reasons by name of 1..n return types
          example: RET
          items:
            type: string
        example: RET
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ShopReturnReason'
        "400":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource.getShop2ReturnReasons(java.util.List)
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource
  /orders/{orderKey}/documents:
    get:
      tags:
      - Document
      summary: Returns all order-related documents
      description: This operation returns a list of all order-related documents provided
        by the IOM.
      operationId: getAllDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getAllDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/creditnotes:
    get:
      tags:
      - Document
      summary: Returns all credit note documents
      description: This operation returns a list of all credit note documents provided
        by the IOM.
      operationId: getCreditDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getCreditDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/delivery:
    get:
      tags:
      - Document
      summary: Returns all delivery note documents
      description: This operation returns a list of all delivery note documents provided
        by the IOM.
      operationId: getDeliveryDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getDeliveryDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/invoicecreditnotes:
    get:
      tags:
      - Document
      summary: Returns all invoice credit note documents
      description: This operation returns a list of all invoice credit note documents
        provided by the IOM.
      operationId: getInvoiceCreditDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getInvoiceCreditDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/invoices:
    get:
      tags:
      - Document
      summary: Returns all invoice documents
      description: This operation returns a list of all invoice documents provided
        by the IOM.
      operationId: getInvoiceDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getInvoiceDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/returnlabel:
    get:
      tags:
      - Document
      summary: Returns all return label documents
      description: This operation returns a list of all return label documents provided
        by the IOM.
      operationId: getReturnLabelDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getReturnLabelDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/returnslip:
    get:
      tags:
      - Document
      summary: Returns all return slip documents
      description: This operation returns a list of all return slip documents provided
        by the IOM.
      operationId: getReturnSlipDocuments
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LinkRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getReturnSlipDocuments()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
  /orders/{orderKey}/documents/{OrderDocumentResourceKey}:
    get:
      tags:
      - Document
      summary: Returns specific document
      description: This operation returns a specific document by its ID.
      operationId: getDocument
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      - name: OrderDocumentResourceKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/OrderDocumentRO'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.document.OrderDocumentRO
        com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource.getDocument()
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource
  /orders/{orderKey}/documents/{OrderDocumentResourceKey}/download:
    get:
      tags:
      - Document
      summary: Returns PDF document
      description: This operation returns a PDF representation of a specific document
        by its ID.
      operationId: download
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      - name: OrderDocumentResourceKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource
      responses:
        "200":
          content:
            application/pdf: {}
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource.download()
        throws java.io.IOException
      x-origin-class: com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource
  /orders/{orderKey}/return-requests:
    get:
      tags:
      - Return Request
      summary: Returns the return requests of an order
      description: "This operation returns a list of return requests created for the\
        \ given order. \nIt returns an empty list if no return request has been created\
        \ yet. "
      operationId: getReturnRequests
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ReadReturnRequest'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource.getReturnRequests()
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource
    post:
      tags:
      - Return Request
      summary: Creates a return request for positions of an order
      description: "This operation creates a new return request for one or more positions\
        \ of an order. \nA return request can only be created if no other return request\
        \ has been accepted for the same position. "
      operationId: createReturnRequest
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/WriteReturnRequest'
      responses:
        "201":
          $ref: '#/components/responses/201'
        "400":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ErrorReport'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource.createReturnRequest(com.intershop.adapter.iomconnector.rma.internal.client.model.WriteReturnRequest)
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource
  /orders/{orderKey}/return-requests/returnables:
    get:
      tags:
      - Return Request
      summary: Returns the returnable order positions to prepare the creation of a
        return request
      description: "This operation returns a list of order positions that can be returned.\
        \ \nIt returns the data that is necessary to enable a client to prepare the\
        \ creation of a return request."
      operationId: getReturnableData
      parameters:
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ReturnableData'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnablesResource.getReturnableData()
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnablesResource
  /orders/{orderKey}/return-requests/{returnRequestId}/custom-attributes:
    get:
      tags:
      - Return Request
      summary: Returns the custom attributes of a return request
      description: "This operation returns a list of custom attributes for the given\
        \ return request of the given order. \nIt returns an empty list in case no\
        \ custom attributes were added to the return request. "
      operationId: getReturnRequestCustomAttributes
      parameters:
      - name: returnRequestId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ReadCustomAttribute'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestCustomAttributeListResource.getReturnRequestCustomAttributes()
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestCustomAttributeListResource
  /orders/{orderKey}/return-requests/{returnRequestId}/positions:
    get:
      tags:
      - Return Request
      summary: Returns the return request positions
      description: This operation returns a list of return request positions for the
        given return request of the given order.
      operationId: getReturnRequestPositions
      parameters:
      - name: returnRequestId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ReadReturnRequestPosition'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestPositionListResource.getReturnRequestPositions()
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestPositionListResource
  /orders/{orderKey}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}/custom-attributes:
    get:
      tags:
      - Return Request
      summary: Returns the return request position custom attributes
      description: "This operation returns a list of custom attributes of a return\
        \ request position of the given order. \nIt returns an empty list in case\
        \ no custom attributes were added to the return request position. \n***[Requires\
        \ IOM RMA API >= 2.12]***"
      operationId: getReturnRequestPositionCustomAttributes
      parameters:
      - name: returnRequestPositionId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: returnRequestId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: orderKey
        in: path
        description: The key or UUID to resolve a single item
        required: true
        schema:
          type: string
        example: ExampleKey
        x-item-key: com.intershop.sellside.rest.common.capi.resource.order.OrderListResource
      responses:
        "200":
          content:
            application/vnd.intershop.order-iom-ext.v1+json:
              schema:
                $ref: '#/components/schemas/ReadCustomAttribute'
        "404":
          $ref: '#/components/responses/404'
        "502":
          $ref: '#/components/responses/502'
      x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestPositionListResource.getReturnRequestPositionCustomAttributes(long)
        throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException
      x-origin-class: com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestPositionListResource
components:
  schemas:
    Error:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: The code of the error
          example: VALIDATION_EXCEPTION
        message:
          type: string
          description: The message of the error
          example: Attribute XYZ is mandatory
        value:
          type: object
          description: The value which caused the error
    ErrorReport:
      type: object
      properties:
        status:
          type: integer
          description: "The HTTP-status code applicable to this problem, expressed\
            \ as a string value"
          format: int32
          example: 400
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      description: Detailed information about errors.
    WriteContactPerson:
      required:
      - emailAddress
      - lastName
      type: object
      properties:
        company:
          type: string
          description: The name of the company of the contact person.
          example: Intershop Communication AG
        firstName:
          type: string
          description: The first name of the contact person.
          example: John
        lastName:
          type: string
          description: The last name of the contact person.
          example: Doe
        phoneNumber:
          type: string
          description: The phone number of the contact person.
          example: 0176 04069077
        emailAddress:
          type: string
          description: The email address of the contact person.
          example: john.doe@intershop.com
        language:
          type: string
          description: The preferred correspondence language to answer the contact
            person (ISO-639-1).
          example: en
      description: Represents a contact person of the return request from an order
        of a shop.
    WriteCustomAttribute:
      required:
      - key
      - value
      type: object
      properties:
        key:
          type: string
          description: The key of a custom attribute.
          example: Example Key
        value:
          type: string
          description: The value of a custom attribute.
          example: Example Value
      description: Represents a custom attribute (key/value pair) of a return request
        from an order of a shop.
    WritePickupAddress:
      required:
      - city
      - countryCode
      - lastName
      - postCode
      - streetName
      type: object
      properties:
        company:
          type: string
          description: The name of the company of the pickup adress.
          example: Intershop Communication AG
        firstName:
          type: string
          description: The first name related to the pickup address.
          example: John
        lastName:
          type: string
          description: The last name related to the pickup address.
          example: Doe
        streetName:
          type: string
          description: The name of the street related to the pickup address.
          example: Alexstraße
        houseNumber:
          type: string
          description: The house number related to the pickup address.
          example: "28"
        postCode:
          type: string
          description: The post code related to the pickup address.
          example: "12053"
        city:
          type: string
          description: The city name related to the pickup address.
          example: Berlin
        countryCode:
          type: string
          description: The ISO 3166-1 alpha-3 code for the country name related to
            the pickup address.
          example: DEU
        district:
          type: string
          description: The district related to the pickup address.
          example: Berlin
        additionFirstLine:
          type: string
          description: The first addition line related to the pickup address.
          example: Finanz
        additionSecondLine:
          type: string
          description: The second addition line related to the pickup address.
          example: 3.Floor
      description: Represents a pickup address related to the return request from
        an order of a shop.
    WriteReturnRequest:
      required:
      - positions
      - type
      type: object
      properties:
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: PICKUP
          enum:
          - RETURN
          - PICKUP
        rmaNumber:
          type: string
          description: The actual number of the return request.
          example: "10901095"
        comment:
          type: string
          description: The comment of the return request.
          example: The battery is draining quickly
        positions:
          type: array
          items:
            $ref: '#/components/schemas/WriteReturnRequestPosition'
        pickupAddress:
          $ref: '#/components/schemas/WritePickupAddress'
        contactPersons:
          type: array
          items:
            $ref: '#/components/schemas/WriteContactPerson'
        customAttributes:
          type: array
          items:
            $ref: '#/components/schemas/WriteCustomAttribute'
      description: Represents a return request from a shop.
    WriteReturnRequestItem:
      required:
      - productSerialNumber
      type: object
      properties:
        productSerialNumber:
          type: string
          description: The serial number of the product.
          example: W88401231AX
      description: Represents a return request item of a return request from an order
        of a shop.
    WriteReturnRequestPosition:
      required:
      - positionNumber
      - productNumber
      - quantity
      - reason
      type: object
      properties:
        positionNumber:
          type: integer
          description: The position number as used by the shop.
          format: int32
          example: 1
        productNumber:
          type: string
          description: The product number as used by the shop.
          example: "20180303123"
        reason:
          type: string
          description: The reason for the return.
          example: RET100
        quantity:
          type: integer
          description: The quantity of the related product by the shop.
          format: int32
          example: 1
        items:
          type: array
          items:
            $ref: '#/components/schemas/WriteReturnRequestItem'
        customAttributes:
          type: array
          items:
            $ref: '#/components/schemas/WriteCustomAttribute'
      description: Represents a return request position of a return request from an
        order of a shop.
    ReadCustomAttribute:
      required:
      - key
      - value
      type: object
      properties:
        key:
          type: string
          description: The key of a custom attribute.
          example: Example Key
        value:
          type: string
          description: The value of a custom attribute.
          example: Example Value
        id:
          type: integer
          description: The custom attribute identifier.
          format: int64
          example: 10000
      description: Represents a custom attribute (key/value pair) of a return request
        from an order of a shop.
    ReadReturnRequestPosition:
      required:
      - positionNumber
      - productNumber
      - quantity
      - reason
      type: object
      properties:
        positionNumber:
          type: integer
          description: The position number as used by the shop.
          format: int32
          example: 1
        productNumber:
          type: string
          description: The product number as used by the shop.
          example: "20180303123"
        reason:
          type: string
          description: The reason for the return.
          example: RET100
        quantity:
          type: integer
          description: The quantity of the related product by the shop.
          format: int32
          example: 1
        id:
          type: integer
          description: The return request position identifier.
          format: int64
          example: 10000
        productName:
          type: string
          description: The product name as used by the shop.
          example: test_product_1
        supplierProductNumber:
          type: string
          description: The article number as used by the supplier.
          example: "20180303123"
        customAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ReadCustomAttribute'
      description: Represents a return request position of a return request from an
        order of a shop.
    ReadReturnRequest:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: PICKUP
          enum:
          - RETURN
          - PICKUP
        rmaNumber:
          type: string
          description: The actual number of the return request.
          example: "10901095"
        comment:
          type: string
          description: The comment of the return request.
          example: The battery is draining quickly
        id:
          type: integer
          description: The return request identifier.
          format: int64
          example: 10000
        creationDate:
          type: string
          description: The date when the return request was created.
          format: date-time
          example: 2018-02-27T09:15:37.562+02:00
        shopOrderNumber:
          type: string
          description: The order number as used by the shop.
          example: "20180303123"
        shopName:
          type: string
          description: The name of the shop.
          example: Test Shop US DE
        supplierOrderNumber:
          type: string
          description: The order number as used by the supplier.
          example: "20180303321"
        supplierName:
          type: string
          description: The name of the supplier.
          example: Test Supplier US DE
        status:
          type: string
          description: The technical status of the return request.
          example: CLOSED
          enum:
          - ACCEPTED
          - CLOSED
          - DO_APPROVE
          - DO_CLOSE
          - INITIAL
          - REJECTED
        businessStatus:
          type: string
          description: The business status of the return request.
          example: ACCEPTED
          enum:
          - ACCEPTED
          - IN_APPROVAL
          - READY_TO_APPROVE
          - REJECTED
          - UNKNOWN
      description: Represents a return request from a shop.
    ReturnableData:
      required:
      - positions
      type: object
      properties:
        positions:
          type: array
          description: Possible order positions / line items to return
          items:
            $ref: '#/components/schemas/ReturnableDataPosition'
      description: Order related information to create a return request
    ReturnableDataItem:
      required:
      - productSerialNumber
      type: object
      properties:
        productSerialNumber:
          type: string
          description: Serial number of the item to return
          example: "667002"
      description: Further information for a single product
    ReturnableDataPosition:
      required:
      - positionNumber
      - product
      - quantity
      type: object
      properties:
        positionNumber:
          type: integer
          description: Order position number as used by the shop
          format: int32
          example: 3
        quantity:
          type: integer
          description: Maximum return quantity
          format: int32
          example: 1
        items:
          type: array
          description: Further information for each single product
          items:
            $ref: '#/components/schemas/ReturnableDataItem'
        product:
          $ref: '#/components/schemas/ReturnableDataProduct'
      description: Order position / line item to return
    ReturnableDataProduct:
      required:
      - name
      - number
      type: object
      properties:
        number:
          type: string
          description: "Shop specific product number, if not available the the IOM\
            \ internal product number"
          example: 100-0001
        name:
          type: string
          description: The name of an element
          example: Demo Product
      description: Product of a still returnable order position
    LinkRO:
      title: Link
      type: object
      properties:
        name:
          type: string
          description: The name of the returned element
          xml:
            attribute: true
        type:
          type: string
          description: "This is a constant: **Link**"
          readOnly: true
          example: Link
          xml:
            attribute: true
        attributes:
          type: array
          description: The list of attributes
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/ResourceAttribute'
        uri:
          type: string
          description: The URI
        relation:
          type: string
          description: The relation of the link
          externalDocs:
            description: Link Relations (www.iana.org)
            url: http://www.iana.org/assignments/link-relations/link-relations.xml
          enum:
          - about
          - alternate
          - appendix
          - archives
          - author
          - bookmark
          - canonical
          - chapter
          - collection
          - contents
          - copyright
          - create-form
          - current
          - describedby
          - describes
          - disclosure
          - duplicate
          - edit
          - edit-form
          - edit-media
          - enclosure
          - first
          - glossary
          - help
          - hosts
          - hub
          - icon
          - index
          - item
          - last
          - latest-version
          - license
          - lrdd
          - monitor
          - monitor-group
          - next
          - next-archive
          - nofollow
          - noreferrer
          - payment
          - predecessor-version
          - prefetch
          - prev
          - preview
          - previous
          - prev-archive
          - privacy-policy
          - profile
          - related
          - replies
          - search
          - section
          - self
          - service
          - start
          - stylesheet
          - subsection
          - successor-version
          - tag
          - terms-of-service
          - type
          - up
          - version-history
          - via
          - working-copy
          - working-copy-of
        title:
          type: string
          description: The title of the link
        description:
          type: string
          description: The description of the link
        itemId:
          type: string
          description: The ID of the linked item
        attribute:
          $ref: '#/components/schemas/ResourceAttribute'
      description: A Link pointing to a resource
      xml:
        name: Link
    ResourceAttribute:
      title: Attribute
      type: object
      properties:
        name:
          type: string
          description: The attribute's name
          xml:
            attribute: true
        type:
          type: string
          description: "This is a constant: **ResourceAttribute**"
          example: ResourceAttribute
          xml:
            attribute: true
        value:
          type: object
          description: The attribute's value.
      description: An attribute
      xml:
        name: ResourceAttribute
    ResourceCollectionROLinkRO:
      title: Link List
      type: object
      properties:
        pageable:
          type: string
          description: The pageable ID.
        total:
          type: integer
          description: The pageable amount total
          format: int32
        offset:
          type: integer
          description: The pageable offset
          format: int32
        amount:
          type: integer
          description: The pageable amount
          format: int32
        elements:
          type: array
          description: The list of elements
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/LinkRO'
        type:
          type: string
          description: "This is a constant: **ResourceCollection**"
          example: ResourceCollection
          xml:
            attribute: true
        sortKeys:
          uniqueItems: true
          type: array
          description: The keys to sort for
          xml:
            wrapped: true
          items:
            type: string
            description: The keys to sort for
            xml:
              name: sortKey
        name:
          type: string
          description: The name of the returned element
          xml:
            attribute: true
      description: A list of links
      xml:
        name: ResourceCollection
    OrderDocumentRO:
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          readOnly: true
          xml:
            attribute: true
        downloadLink:
          type: string
        creationDate:
          type: string
          format: date-time
        id:
          type: string
    ShopReturnReason:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          example: RET010
        description:
          type: string
          description: Description of return reason
          example: return of goods / general
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RET
      description: "Possible return reason, configured for a IOM shop instance"
  responses:
    "200":
      description: OK
    "201":
      description: Created
    "202":
      description: Accepted
    "204":
      description: No Content
    "205":
      description: Reset Content
    "206":
      description: Partial Content
    "300":
      description: Multiple Choices
    "301":
      description: Moved Permanently
    "302":
      description: Found
    "303":
      description: See Other
    "304":
      description: Not Modified
    "305":
      description: Use Proxy
    "307":
      description: Temporary Redirect
    "308":
      description: Permanent Redirect
    "400":
      description: Bad Request
    "401":
      description: Unauthorized
    "402":
      description: Payment Required
    "403":
      description: Forbidden
    "404":
      description: Not Found
    "405":
      description: Method Not Allowed
    "406":
      description: Not Acceptable
    "407":
      description: Proxy Authentication Required
    "408":
      description: Request Timeout
    "409":
      description: Conflict
    "410":
      description: Gone
    "411":
      description: Length Required
    "412":
      description: Precondition Failed
    "413":
      description: Request Entity Too Large
    "414":
      description: Request-URI Too Long
    "415":
      description: Unsupported Media Type
    "416":
      description: Requested Range Not Satisfiable
    "417":
      description: Expectation Failed
    "428":
      description: Precondition Required
    "429":
      description: Too Many Requests
    "431":
      description: Request Header Fields Too Large
    "451":
      description: Unavailable For Legal Reasons
    "500":
      description: Internal Server Error
    "501":
      description: Not Implemented
    "502":
      description: Bad Gateway
    "503":
      description: Service Unavailable
    "504":
      description: Gateway Timeout
    "505":
      description: HTTP Version Not Supported
    "511":
      description: Network Authentication Required
  parameters:
    loc:
      name: loc
      in: path
      description: "The locale ID (submitted as optional matrix parameter ```;loc=<LOCALE>```).\
        \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\
        \ user's default locale, site's default locale. The available locales depend\
        \ on your individual Intershop Commerce Management installation. Use IANA\
        \ language definitions for languages and regions and combine them using a\
        \ underscore, e. g. ```en_US```."
      required: false
      style: matrix
      schema:
        type: string
        description: "The locale ID (submitted as optional matrix parameter ```;loc=<LOCALE>```).\
          \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\
          \ user's default locale, site's default locale. The available locales depend\
          \ on your individual Intershop Commerce Management installation. Use IANA\
          \ language definitions for languages and regions and combine them using\
          \ a underscore, e. g. ```en_US```."
        default: en_US
      examples:
        en_US:
          description: English (United States)
          value: en_US
        fr_FR:
          description: French (France)
          value: fr_FR
        de_DE:
          description: German (Germany)
          value: de_DE
      x-matrixParamPath: /
    cur:
      name: cur
      in: path
      description: "The currency code (submitted as optional matrix parameter ```;cur=<CURRENCY>```).\
        \ If omitted, the site's or user's default currency is used."
      required: false
      style: matrix
      schema:
        type: string
        description: "The currency code (submitted as optional matrix parameter ```;cur=<CURRENCY>```).\
          \ If omitted, the site's or user's default currency is used."
        default: USD
      examples:
        FJD:
          description: Fiji Dollar
          value: FJD
        MXN:
          description: Mexican Peso
          value: MXN
        STD:
          description: São Tomé / Príncipe Dobra
          value: STD
        LVL:
          description: Latvian Lats
          value: LVL
        SCR:
          description: Seychelles Rupee
          value: SCR
        CDF:
          description: Congolese Franc
          value: CDF
        BBD:
          description: Barbados Dollar
          value: BBD
        GTQ:
          description: Guatemalan Quetzal
          value: GTQ
        CLP:
          description: Chilean Peso
          value: CLP
        HNL:
          description: Honduran Lempira
          value: HNL
        UGX:
          description: Ugandan Shilling
          value: UGX
        ZAR:
          description: South African Rand
          value: ZAR
        TND:
          description: Tunisian Dinar
          value: TND
        BSD:
          description: Bahamian Dollar
          value: BSD
        SLL:
          description: Sierra Leonean Leone
          value: SLL
        SDG:
          description: Sudanese Pound
          value: SDG
        IQD:
          description: Iraqi Dinar
          value: IQD
        CUP:
          description: Cuban Peso
          value: CUP
        GMD:
          description: Gambian Dalasi
          value: GMD
        TWD:
          description: New Taiwan Dollar
          value: TWD
        RSD:
          description: Serbian Dinar
          value: RSD
        ZRZ:
          description: Zaire
          value: ZRZ
        DOP:
          description: Dominican Peso
          value: DOP
        KMF:
          description: Comoro Franc
          value: KMF
        MYR:
          description: Malaysian Ringgit
          value: MYR
        FKP:
          description: Falkland Islands Pound
          value: FKP
        XOF:
          description: CFA Franc BCEAO
          value: XOF
        GEL:
          description: Lari
          value: GEL
        UYU:
          description: Uruguayan Peso
          value: UYU
        MAD:
          description: Moroccan Dirham
          value: MAD
        CVE:
          description: Cape Verde Escudo
          value: CVE
        TOP:
          description: Tongan Pa'anga
          value: TOP
        AZN:
          description: Azerbaijanian Manat
          value: AZN
        OMR:
          description: Omani Rial
          value: OMR
        PGK:
          description: Papua New Guinean Kina
          value: PGK
        KES:
          description: Kenyan Shilling
          value: KES
        SEK:
          description: Swedish Krona
          value: SEK
        BTN:
          description: Ngultrum
          value: BTN
        UAH:
          description: Ukrainian Hryvnia
          value: UAH
        GNF:
          description: Guinea Franc
          value: GNF
        ERN:
          description: Nakfa
          value: ERN
        MZN:
          description: Mozambican Metical
          value: MZN
        SVC:
          description: Salvadoran Colón
          value: SVC
        ARS:
          description: Argentine Peso
          value: ARS
        QAR:
          description: Qatari Riyal
          value: QAR
        IRR:
          description: Iranian Rial
          value: IRR
        NLG:
          description: Dutch Guilder
          value: NLG
        MRO:
          description: Mauritanian Ouguiya
          value: MRO
        CNY:
          description: Yuan Renminbi
          value: CNY
        THB:
          description: Thai Baht
          value: THB
        UZS:
          description: Uzbekistani Som
          value: UZS
        XPF:
          description: CFP Franc
          value: XPF
        BDT:
          description: Bangladeshi Taka
          value: BDT
        LYD:
          description: Libyan Dinar
          value: LYD
        BMD:
          description: Bermudian Dollar
          value: BMD
        KWD:
          description: Kuwaiti Dinar
          value: KWD
        PHP:
          description: Philippine Peso
          value: PHP
        RUB:
          description: Russian Ruble
          value: RUB
        PYG:
          description: Paraguayan Guarani
          value: PYG
        ISK:
          description: Iceland Krona
          value: ISK
        JMD:
          description: Jamaican Dollar
          value: JMD
        GWP:
          description: Guinea Peso
          value: GWP
        BEF:
          description: Belgian Franc
          value: BEF
        ESP:
          description: Spanish Peseta
          value: ESP
        COP:
          description: Colombian Peso
          value: COP
        MKD:
          description: Denar
          value: MKD
        USD:
          description: US Dollar
          value: USD
        DZD:
          description: Algerian Dinar
          value: DZD
        PAB:
          description: Panamanian Balboa
          value: PAB
        SGD:
          description: Singapore Dollar
          value: SGD
        ETB:
          description: Ethiopian Birr
          value: ETB
        KGS:
          description: Som
          value: KGS
        SOS:
          description: Somali Shilling
          value: SOS
        VEF:
          description: Venezuelan Bolivar Fuerte
          value: VEF
        VUV:
          description: Vanuatu Vatu
          value: VUV
        LAK:
          description: Lao Kip
          value: LAK
        BND:
          description: Brunei Dollar
          value: BND
        ZMK:
          description: Zambian Kwacha
          value: ZMK
        XAF:
          description: CFA Franc BEAC
          value: XAF
        LRD:
          description: Liberian Dollar
          value: LRD
        ATS:
          description: Austrian Schilling
          value: ATS
        CHF:
          description: Swiss Franc
          value: CHF
        HRK:
          description: Croatian Kuna
          value: HRK
        ITL:
          description: Italian Lira
          value: ITL
        ALL:
          description: Albanian Lek
          value: ALL
        DJF:
          description: Djibouti Franc
          value: DJF
        MTL:
          description: Maltese Lira
          value: MTL
        TZS:
          description: Tanzanian Shilling
          value: TZS
        VND:
          description: Vietnamese Dong
          value: VND
        AUD:
          description: Australian Dollar
          value: AUD
        ILS:
          description: New Israeli Sheqel
          value: ILS
        GHS:
          description: Ghanaian Cedi
          value: GHS
        GYD:
          description: Guyanese Dollar
          value: GYD
        KPW:
          description: North Korean Won
          value: KPW
        BOB:
          description: Boliviano
          value: BOB
        KHR:
          description: Cambodian Riel
          value: KHR
        MDL:
          description: Moldovan Leu
          value: MDL
        IDR:
          description: Indonesian Rupiah
          value: IDR
        KYD:
          description: Cayman Islands Dollar
          value: KYD
        AMD:
          description: Armenian Dram
          value: AMD
        BWP:
          description: Botswana Pula
          value: BWP
        SHP:
          description: Saint Helena Pound
          value: SHP
        TRY:
          description: Turkish Lira
          value: TRY
        CYP:
          description: Cyprus Pound
          value: CYP
        LBP:
          description: Lebanese Pound
          value: LBP
        TJS:
          description: Tajikistani Somoni
          value: TJS
        JOD:
          description: Jordanian Dinar
          value: JOD
        AED:
          description: United Arab Emirates Dirham
          value: AED
        HKD:
          description: Hong Kong Dollar
          value: HKD
        RWF:
          description: Rwanda Franc
          value: RWF
        EUR:
          description: Euro
          value: EUR
        LSL:
          description: Lesotho Loti
          value: LSL
        DKK:
          description: Danish Krone
          value: DKK
        CAD:
          description: Canadian Dollar
          value: CAD
        BGN:
          description: Bulgarian Lev
          value: BGN
        EEK:
          description: Estonian Kroon
          value: EEK
        MMK:
          description: Kyat
          value: MMK
        MUR:
          description: Mauritian Rupee
          value: MUR
        NOK:
          description: Norwegian Krone
          value: NOK
        SYP:
          description: Syrian Pound
          value: SYP
        ZWL:
          description: Zimbabwean Dollar
          value: ZWL
        GIP:
          description: Gibraltar Pound
          value: GIP
        RON:
          description: Romanian New Leu
          value: RON
        LKR:
          description: Sri Lankan Rupee
          value: LKR
        NGN:
          description: Nigerian Naira
          value: NGN
        CRC:
          description: Costa Rican Colon
          value: CRC
        CZK:
          description: Czech Koruna
          value: CZK
        IEP:
          description: Irish Pound
          value: IEP
        PKR:
          description: Pakistani Rupee
          value: PKR
        GRD:
          description: Greek Drachma
          value: GRD
        XCD:
          description: East Carribean Dollar
          value: XCD
        ANG:
          description: Netherlands Antillian Guilder
          value: ANG
        HTG:
          description: Haitian Gourde
          value: HTG
        BHD:
          description: Bahraini Dinar
          value: BHD
        SIT:
          description: Slovenian Tolar
          value: SIT
        PTE:
          description: Portuguese Escudo
          value: PTE
        BPP:
          description: Bonus Point Price
          value: BPP
        KZT:
          description: Kazakhstani Tenge
          value: KZT
        SRD:
          description: Surinam Dollar
          value: SRD
        SZL:
          description: Swazi Lilangeni
          value: SZL
        LTL:
          description: Lithuanian Litas
          value: LTL
        SAR:
          description: Saudi Riyal
          value: SAR
        TTD:
          description: Trinidad and Tobago Dollar
          value: TTD
        YER:
          description: Yemeni Rial
          value: YER
        MVR:
          description: Maldivian Rufiyaa
          value: MVR
        AFN:
          description: Afghani
          value: AFN
        BPV:
          description: Bonus Point Value
          value: BPV
        INR:
          description: Indian Rupee
          value: INR
        AWG:
          description: Aruban Florin
          value: AWG
        KRW:
          description: South Korean Won
          value: KRW
        NPR:
          description: Nepalese Rupee
          value: NPR
        JPY:
          description: Japanese Yen
          value: JPY
        MNT:
          description: Mongolian Tugrik
          value: MNT
        AOA:
          description: Angolan Kwanza
          value: AOA
        PLN:
          description: Polish Złoty
          value: PLN
        GBP:
          description: Pound Sterling
          value: GBP
        SBD:
          description: Solomon Islands Dollar
          value: SBD
        HUF:
          description: Hungarian Forint
          value: HUF
        BYR:
          description: Belarussian Ruble
          value: BYR
        LUF:
          description: Luxembourgian Franc
          value: LUF
        BIF:
          description: Burundi Franc
          value: BIF
        MWK:
          description: Malawian Kwacha
          value: MWK
        MGA:
          description: Malagasy Ariary
          value: MGA
        FIM:
          description: Finnish Mark
          value: FIM
        BZD:
          description: Belize Dollar
          value: BZD
        DEM:
          description: Deutsche Mark
          value: DEM
        BAM:
          description: Convertible Marks
          value: BAM
        EGP:
          description: Egyptian Pound
          value: EGP
        MOP:
          description: Macanese Pataca
          value: MOP
        NAD:
          description: Namibian Dollar
          value: NAD
        SKK:
          description: Slovakian Krona
          value: SKK
        NIO:
          description: Cordoba Oro
          value: NIO
        PEN:
          description: Peruvian Nuevo Sol
          value: PEN
        NZD:
          description: New Zealand Dollar
          value: NZD
        WST:
          description: Samoan Tala
          value: WST
        TMT:
          description: Turkmenistani Manat
          value: TMT
        FRF:
          description: French Franc
          value: FRF
        BRL:
          description: Brazilian Real
          value: BRL
      x-matrixParamPath: /
    regionals:
      name: regionals
      in: path
      required: false
      style: matrix
      schema:
        type: object
        properties:
          loc:
            type: string
            description: The locale ID
            example: en_US
          cur:
            type: string
            description: The currency code
            example: EUR
      x-matrixParamPath: /
    pgid:
      name: pgid
      in: path
      description: "The personalization group identifier, submitted as matrix parameter\
        \ ```;pgid=<PGID>```. Required if you want to work with customer-specific\
        \ content."
      required: false
      style: matrix
      schema:
        type: string
        description: "The personalization group identifier, submitted as matrix parameter\
          \ ```;pgid=<PGID>```. Required if you want to work with customer-specific\
          \ content."
        example: FUOGrzQ_VjORpGaN8DRGmLLE0000
      example: FUOGrzQ_VjORpGaN8DRGmLLE0000
    spgid:
      name: spgid
      in: path
      description: "The secure personalization group identifier, submitted as matrix\
        \ parameter ```;spgid=<PGID>```. Required if you want to work with customer-specific\
        \ content."
      required: false
      style: matrix
      schema:
        type: string
        description: "The secure personalization group identifier, submitted as matrix\
          \ parameter ```;spgid=<PGID>```. Required if you want to work with customer-specific\
          \ content."
        example: FUOGrzQ_VjORpGaN8DRGmLLE0000
      example: FUOGrzQ_VjORpGaN8DRGmLLE0000
  securitySchemes:
    basicAuth:
      type: http
      description: "Basic access authentication. In basic authentication, a request\
        \ contains a header field in the form of authorization: ```Basic <credentials>```,\
        \  where credentials is the Base64 encoding of ID and password joined by a\
        \ single colon :."
      scheme: basic
    authToken:
      type: apiKey
      description: User authentication token to authenticate the request. The token
        is a string generated by the ICM server in the same header in every response
        of an REST endpoint.
      name: authentication-token
      in: header
    bearerAuth:
      type: http
      description: "Bearer token authentication. A request contains a header field\
        \ in the form of authorization: ```Bearer <token>```, where <token> is a string\
        \ generated by an authentication service in response to a login request."
      scheme: bearer
      bearerFormat: JWT
x-apiID: order_iom_ext_v1
x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource,com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource,com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource,com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource"