openapi: 3.0.1
info:
  title: Order
  description: "This is Intershop ICM REST API documentation. \n\nThis reference lists\
    \ the REST API for storefront development. The REST API covers features of both,\
    \ the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.\
    \ \nThis reference is intended for developers who want to make use of an easy-to-use\
    \ API when developing frontend solutions.\nYou can find more information at [Intershop\
    \ Communications](https://www.intershop.com). Contact our Intershop experts at\
    \ [Support - Intershop Communications](https://www.intershop.com/en/support) \
    \ \n\n# Introduction\nThis API is documented in **OpenAPI format**.\n\n"
  version: 1.0.0-beta
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
      enum:
      - smb-responsive
      default: '-'
tags:
- name: General
  x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource
- name: Line Item
  x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource
paths:
  /orders:
    get:
      tags:
      - General
      summary: __BETA__ | Returns the list of orders for the user.
      description: Returns the list of orders for the user. If user authentication fails, a 401 error with body string 'Unauthorized' is returned.
      operationId: getOrders_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - buckets
            - commonShipToAddress
            - commonShippingMethod
            - discounts
            - invoiceToAddress
            - lineItems
            - payments
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO
        x-include-type-lineItems: OrderLineItemRO_v1
        x-include-type-buckets: OrderShippingBucketRO_v1
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-invoiceToAddress: AddressRO_v1
        x-include-type-commonShipToAddress: AddressRO_v1
        x-include-type-commonShippingMethod: OrderShippingMethodRO_v1
        x-include-type-payments: PaymentRO_v1
      - name: filter[statusCode]
        in: query
        description: Filters orders by their (case-sensitive) order status.
        schema:
          type: string
          default: ""
        example: filter[statusCode]=NEW,PENDING
      - name: page[limit]
        in: query
        description: Limits the number of orders returned in th response.
        schema:
          type: integer
          format: int32
        example: page[limit]=10
      responses:
        200:
          description: The list of orders.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderListCtnrRO_v1'
        401:
          description: If the user couldn't be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
        422:
          description: In case of semantical errors of the request, e.g. invalid status code filter.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderListCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderListResource.getOrders_V1(java.lang.String,java.lang.String,java.lang.Integer)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.order.OrderListResource
    post:
      tags:
      - General
      summary: __BETA__ | Creates a new order for the user from a given basket.
      description: Creates a new order for the user from a given basket. If the basket is not valid or there are other errors during order creation, then status 422 together with a cause description is returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned.
      operationId: createOrder_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - buckets
            - commonShipToAddress
            - commonShippingMethod
            - discounts
            - invoiceToAddress
            - lineItems
            - payments
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO
        x-include-type-lineItems: OrderLineItemRO_v1
        x-include-type-buckets: OrderShippingBucketRO_v1
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-invoiceToAddress: AddressRO_v1
        x-include-type-commonShipToAddress: AddressRO_v1
        x-include-type-commonShippingMethod: OrderShippingMethodRO_v1
        x-include-type-payments: PaymentRO_v1
      requestBody:
        description: The object containing the required data for the order creation.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/OrderRO_v1'
      responses:
        201:
          description: The created order if the process finished successfully.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        202:
          description: If the order was created, but additional steps need to be performed before the order creation is finished (e. g. a redirect to the payment service provider). A "PATCH" request on the order item resource needs to be invoked afterwards to continue the order creation process.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        422:
          description: If the order could not be created because of semantical errors.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        401:
          description: If the user couldn't be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderListResource.createOrder_V1(com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO,java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.order.OrderListResource
  /orders/{orderKey}:
    get:
      tags:
      - General
      summary: __BETA__ | Returns the order with the given ID.
      description: Returns the order with the given ID for the user. If no order with this ID is found, a 404 error will be returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. Error 403 is returned, if the user does not have the required access privileges. Error 410 is returned, if order is abort with payment canceled.
      operationId: getOrder_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - buckets
            - commonShipToAddress
            - commonShippingMethod
            - discounts
            - invoiceToAddress
            - lineItems
            - payments
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO
        x-include-type-lineItems: OrderLineItemRO_v1
        x-include-type-buckets: OrderShippingBucketRO_v1
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-invoiceToAddress: AddressRO_v1
        x-include-type-commonShipToAddress: AddressRO_v1
        x-include-type-commonShippingMethod: OrderShippingMethodRO_v1
        x-include-type-payments: PaymentRO_v1
      - 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:
          description: The order with the given ID.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        404:
          description: If no order is found.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        401:
          description: If the user could not be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
        403:
          description: If the user does not have the required access privileges.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
        410:
          description: If order is abort with payment canceled.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderItemResource.getOrder_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.order.OrderItemResource
    patch:
      tags:
      - General
      summary: __BETA__ | Updates the order with the given ID.
      description: Updates the order with the given ID. This is currently only used to continue an interrupted order creation process (e. g. because of a payment which required a redirect) by setting the "orderCreation.status" field to "CONTINUE". If there are errors during the continued order process, status 422 with an appropriate cause description is returned. If no order with this ID is found for the user, a 404 error will be returned. If user authentication fails, a 401 error with body string "Unauthorized" is returned.
      operationId: updateOrder_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - buckets
            - commonShipToAddress
            - commonShippingMethod
            - discounts
            - invoiceToAddress
            - lineItems
            - payments
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO
        x-include-type-lineItems: OrderLineItemRO_v1
        x-include-type-buckets: OrderShippingBucketRO_v1
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-invoiceToAddress: AddressRO_v1
        x-include-type-commonShipToAddress: AddressRO_v1
        x-include-type-commonShippingMethod: OrderShippingMethodRO_v1
        x-include-type-payments: PaymentRO_v1
      - 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:
        description: The object containing the data to update the order with the given ID.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/OrderRO_v1'
      responses:
        200:
          description: The updated order if the order process is completed.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        202:
          description: If the order process was continued, but additional steps need to be performed by the client before the order creation is finished (e. g. another redirect to a different payment service provider).
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        422:
          description: If the order could not be updated because of semantical errors.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        404:
          description: If an order with the given ID is not found in the list of user orders.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderCtnrRO_v1'
        401:
          description: If the user could not be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderItemResource.updateOrder_V1(com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO,java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.order.OrderItemResource
  /orders/{orderKey}/attributes:
    get:
      tags:
      - General
      summary: __BETA__ | Returns (custom) attributes for the order.
      operationId: getOrderAttributes_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        schema:
          type: string
          default: ""
        x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO
      - 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:
          description: The list of attributes.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/AttributeListCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource.getAttributes_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource
    post:
      tags:
      - General
      summary: __BETA__ | Creates a new (custom) attribute at the order.
      description: Creates a new (custom) attribute at the order. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.
      operationId: createOrderAttribute_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        schema:
          type: string
          default: ""
        x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO
      - 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:
        description: The object containing the attribute data.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AttributeRO_v1'
      responses:
        201:
          description: The created attribute.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/AttributeCtnrRO_v1'
        422:
          description: If the attribute could not be created because of semantic errors in the passed data.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/AttributeCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource
  /orders/{orderKey}/buckets:
    get:
      tags:
      - Shipping Bucket
      summary: __BETA__ | Returns the list of shipping buckets for the selected order.
      description: Returns the list of shipping buckets for the selected order. Note that buckets are built dynamically and are not persisted. Bucket assignments and IDs could change if items are moved to a different bucket (by changing ship-to address or shipping method of a line item). It is therefore recommended to always retrieve the list of buckets before performing any operation on a single bucket.
      operationId: getShippingBuckets_V1
      parameters:
      - name: include
        in: query
        description: Related objects which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - discounts
            - shipToAddress
            - shippingMethod
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.shipping.ShippingBucketRO
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-shipToAddress: AddressRO_v1
        x-include-type-shippingMethod: OrderShippingMethodRO_v1
      - 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:
          description: The list of shipping buckets.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderShippingBucketListCtnrRO_v1'
        401:
          description: If the user couldn't be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.shipping.ShippingBucketListResource.getShippingBuckets_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.shipping.ShippingBucketListResource
  /orders/{orderKey}/buckets/{ShippingBucketKey}:
    get:
      tags:
      - Shipping Bucket
      summary: __BETA__ | Returns the shipping bucket with the given ID.
      description: Returns the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. Note that this could also mean that items have been added or removed from the bucket, as buckets are not persisted and IDs are determined dynamically through a hash over all items in the bucket. If such changes occur, the shipping bucket list needs to be retrieved again before working on single buckets.
      operationId: getShippingBucket_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - discounts
            - shipToAddress
            - shippingMethod
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.shipping.ShippingBucketRO
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-shipToAddress: AddressRO_v1
        x-include-type-shippingMethod: OrderShippingMethodRO_v1
      - 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: ShippingBucketKey
        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.order.v1.capi.resource.shipping.ShippingBucketListResource
      responses:
        200:
          description: The shipping bucket.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderShippingBucketCtnrRO_v1'
        404:
          description: If a shipping bucket with the given ID is not found in the order.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderShippingBucketCtnrRO_v1'
        401:
          description: If the user couldn't be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.shipping.ShippingBucketItemResource.getShippingBucket_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.shipping.ShippingBucketItemResource
  /orders/{orderKey}/items:
    get:
      tags:
      - Line Item
      summary: __BETA__ | Returns the list of line items for the selected order.
      operationId: getLineItems_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - discounts
            - product
            - shipToAddress
            - shippingMethod
            - warranty
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.lineitem.LineItemRO
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-product: OrderProductRO_v1
        x-include-type-shipToAddress: AddressRO_v1
        x-include-type-shippingMethod: OrderShippingMethodRO_v1
        x-include-type-warranty: OrderWarrantyRO_v1
      - 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:
          description: The list of line items.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderLineItemListCtnrRO_v1'
        401:
          description: If the user couldn't be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemListResource.getLineItems_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemListResource
  /orders/{orderKey}/items/{LineItemKey}:
    get:
      tags:
      - Line Item
      summary: __BETA__ | Returns the line item for the given ID.
      description: 'Returns the line item for the given ID. If no line item with this
        ID is found, a 404 error will be returned. '
      operationId: getLineItem_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - discounts
            - product
            - shipToAddress
            - shippingMethod
            - warranty
        x-supported-include-type: com.intershop.sellside.rest.order.v1.capi.resourceobject.lineitem.LineItemRO
        x-include-type-discounts: OrderDiscountRO_v1
        x-include-type-product: OrderProductRO_v1
        x-include-type-shipToAddress: AddressRO_v1
        x-include-type-shippingMethod: OrderShippingMethodRO_v1
        x-include-type-warranty: OrderWarrantyRO_v1
      - 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: LineItemKey
        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.order.v1.capi.resource.lineitem.LineItemListResource
      responses:
        200:
          description: Information message describing success status.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderLineItemCtnrRO_v1'
        404:
          description: If a line item with the given ID is not found in the order.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/OrderLineItemCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemItemResource.getLineItem_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemItemResource
  /orders/{orderKey}/items/{LineItemKey}/attributes:
    get:
      tags:
      - Line Item
      summary: __BETA__ | Returns (custom) attributes for the line item.
      operationId: getLineItemAttributes_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        schema:
          type: string
          default: ""
        x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO
      - 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: LineItemKey
        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.order.v1.capi.resource.lineitem.LineItemListResource
      responses:
        200:
          description: The list of attributes.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/AttributeListCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource.getAttributes_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource
    post:
      tags:
      - Line Item
      summary: __BETA__ | Creates a new (custom) attribute at the line item.
      description: Creates a new (custom) attribute at the line item. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.
      operationId: createLineItemAttribute_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        schema:
          type: string
          default: ""
        x-supported-include-type: com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO
      - 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: LineItemKey
        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.order.v1.capi.resource.lineitem.LineItemListResource
      requestBody:
        description: The object containing the attribute data.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AttributeRO_v1'
      responses:
        201:
          description: The created attribute.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/AttributeCtnrRO_v1'
        422:
          description: If the attribute could not be created because of semantic errors in the passed data.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/AttributeCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource
  /orders/{orderKey}/payments:
    get:
      tags:
      - Payment
      summary: __BETA__ | Returns the list of payments assigned to the order.
      operationId: getPayments_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - paymentInstrument
            - paymentMethod
        x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO
        x-include-type-paymentInstrument: PaymentInstrumentRO_v1
        x-include-type-paymentMethod: PaymentMethodRO_v1
      - 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:
          description: The list of payments.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/PaymentCtnrRO_v1'
        401:
          description: If the user couldn't be authenticated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                type: string
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentListResource.getPayments_V1(java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentListResource
  /orders/{orderKey}/payments/{PaymentKey}:
    patch:
      tags:
      - Payment
      summary: __BETA__ | Updates the payment.
      description: Updates the payment. If the payment could not be updated, a 422 error will be returned. Note that this will only allow to set/update redirect data, e.g. the return URLS'. Other changes are not supported and will be ignored.
      operationId: updatePayment_V1
      parameters:
      - name: include
        in: query
        description: Related objects (as a comma separated list) which are to be included with the response.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - all
            - paymentInstrument
            - paymentMethod
        x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO
        x-include-type-paymentInstrument: PaymentInstrumentRO_v1
        x-include-type-paymentMethod: PaymentMethodRO_v1
      - 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: PaymentKey
        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.order.v1.capi.resource.payment.PaymentListResource
      requestBody:
        description: The object containing the updated redirect data for the payment.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/PaymentRO_v1'
      responses:
        200:
          description: Information message describing success status.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/PaymentCtnrRO_v1'
        422:
          description: If the payment could not be updated.
          content:
            application/vnd.intershop.order.v1+json:
              schema:
                $ref: '#/components/schemas/PaymentCtnrRO_v1'
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource.updatePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)
      x-origin-class: com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource
components:
  schemas:
    AttributeRO_v1:
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
          description: The name of an element.
        type:
          type: string
          description: 'The type of the object. This is normally a **constant** that
            can be used to differentiate objects by their type. '
          enum:
          - Boolean
          - Date
          - Decimal
          - Double
          - Integer
          - Long
          - Money
          - Quantity
          - String
          - Text
          - MultipleBoolean
          - MultipleDate
          - MultipleDecimal
          - MultipleDouble
          - MultipleInteger
          - MultipleLong
          - MultipleString
        value:
          type: object
      description: A representation of an attribute.
      discriminator:
        propertyName: type
        mapping:
          Boolean: '#/components/schemas/BooleanAttributeRO_v1'
          Date: '#/components/schemas/DateAttributeRO_v1'
          Decimal: '#/components/schemas/DecimalAttributeRO_v1'
          Double: '#/components/schemas/DoubleAttributeRO_v1'
          Integer: '#/components/schemas/IntegerAttributeRO_v1'
          Long: '#/components/schemas/LongAttributeRO_v1'
          Money: '#/components/schemas/MoneyAttributeRO_v1'
          Quantity: '#/components/schemas/QuantityAttributeRO_v1'
          String: '#/components/schemas/StringAttributeRO_v1'
          Text: '#/components/schemas/TextAttributeRO_v1'
          MultipleBoolean: '#/components/schemas/MultipleBooleanAttributeRO_v1'
          MultipleDate: '#/components/schemas/MultipleDateAttributeRO_v1'
          MultipleDecimal: '#/components/schemas/MultipleDecimalAttributeRO_v1'
          MultipleDouble: '#/components/schemas/MultipleDoubleAttributeRO_v1'
          MultipleInteger: '#/components/schemas/MultipleIntegerAttributeRO_v1'
          MultipleLong: '#/components/schemas/MultipleLongAttributeRO_v1'
          MultipleString: '#/components/schemas/MultipleStringAttributeRO_v1'
      oneOf:
      - $ref: '#/components/schemas/BooleanAttributeRO_v1'
      - $ref: '#/components/schemas/DateAttributeRO_v1'
      - $ref: '#/components/schemas/DecimalAttributeRO_v1'
      - $ref: '#/components/schemas/DoubleAttributeRO_v1'
      - $ref: '#/components/schemas/IntegerAttributeRO_v1'
      - $ref: '#/components/schemas/LongAttributeRO_v1'
      - $ref: '#/components/schemas/MoneyAttributeRO_v1'
      - $ref: '#/components/schemas/QuantityAttributeRO_v1'
      - $ref: '#/components/schemas/StringAttributeRO_v1'
      - $ref: '#/components/schemas/TextAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleBooleanAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleDateAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleDecimalAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleDoubleAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleIntegerAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleLongAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleStringAttributeRO_v1'
    BooleanAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a boolean attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: boolean
            description: The boolean attribute value.
    DateAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a date/time attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: string
            description: The date/time attribute value.
            format: date-time
            example: 2020-05-23T13:23:45+02:00
    DecimalAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a decimal attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: number
            description: The decimal attribute value.
    DoubleAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a double attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: number
            description: The double attribute value.
            format: double
    FeedbackCauseRO_v1:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: An unique identifier for this particular occurrence of the problem (may be used for localization on client-side).
          example: invoiceToAddress.address.postalcode.invalid
        message:
          type: string
          description: A human readable message in request's locale (server falls back to lead locale if requested local is not supported).
          example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
        parameters:
          type: object
          additionalProperties:
            type: object
            description: A map of several parameters that are used to assemble the message.
          description: A map of several parameters that are used to assemble the message.
        paths:
          type: array
          description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity.
          externalDocs:
            url: https://github.com/json-path/JsonPath
          items:
            type: string
            description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity.
            externalDocs:
              url: https://github.com/json-path/JsonPath
      description: A representation for the common feedback informations.
    FeedbackRO_v1:
      type: object
      properties:
        causes:
          type: array
          description: A collection of errors/infos that caused this feedback.
          items:
            $ref: '#/components/schemas/FeedbackCauseRO_v1'
        code:
          type: string
          description: An unique identifier for this particular occurrence of the problem (may be used for localization on client-side).
          example: invoiceToAddress.address.postalcode.invalid
        message:
          type: string
          description: A human readable message in request's locale (server falls back to lead locale if requested local is not supported).
          example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
        parameters:
          type: object
          additionalProperties:
            type: object
            description: A map of several parameters that are used to assemble the message.
          description: A map of several parameters that are used to assemble the message.
        paths:
          type: array
          description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity.
          externalDocs:
            url: https://github.com/json-path/JsonPath
          items:
            type: string
            description: A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity.
            externalDocs:
              url: https://github.com/json-path/JsonPath
        status:
          type: string
          description: The HTTP status code, that is applicable to this problem.
          example: "400"
      description: An error or information representation regarding the current request.
      readOnly: true
    IntegerAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of an integer attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: integer
            description: The integer attribute value.
            format: int32
    JurisdictionRO_v1:
      type: object
      properties:
        id:
          type: string
          description: The jurisdiction ID.
          example: CANADA
        level:
          type: string
          description: The level of the jurisdiction for which the tax is applied.
          example: COUNTRY
          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.
      readOnly: true
    LongAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a long attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: integer
            description: The long attribute value.
            format: int64
    MoneyAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a money attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/MoneyRO_v1'
    MoneyRO_v1:
      type: object
      properties:
        currency:
          type: string
          description: Three-letter currency code (ISO 4217) of the monetary value.
          example: USD
        value:
          type: number
          description: The monetary value.
          example: 10.99
      description: Describes a money object.
      readOnly: true
    MultipleBooleanAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple boolean attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple boolean attribute value.
            items:
              type: boolean
              description: The multiple boolean attribute value.
    MultipleDateAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple date/time attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple date/time attribute value.
            items:
              type: string
              description: The multiple date/time attribute value.
              format: date-time
    MultipleDecimalAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple decimal attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple decimal attribute value.
            items:
              type: number
              description: The multiple decimal attribute value.
    MultipleDoubleAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple double attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple double attribute value.
            items:
              type: number
              description: The multiple double attribute value.
              format: double
    MultipleIntegerAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple integer attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple integer attribute value.
            items:
              type: integer
              description: The multiple integer attribute value.
              format: int32
    MultipleLongAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple long attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple long attribute value.
            items:
              type: integer
              description: The multiple long attribute value.
              format: int64
    MultipleStringAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a multiple string attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: array
            description: The multiple string attribute value.
            items:
              type: string
              description: The multiple string attribute value.
    OrderCreationRO_v1:
      type: object
      properties:
        redirect:
          $ref: '#/components/schemas/PaymentRedirectRO_v1'
        status:
          type: string
          description: Represents the status of the order creation process. If this returns "COMPLETED", then the order creation is finished. If this returns "ROLLED_BACK", then the order creation was unsuccessful (e. g. because of a failed or cancelled payment) and the order is rolled back and becomes inaccessible. If this returns "STOPPED", then the client needs to perform the action from the "stopAction" field first. Once done, the order creation can be continued by setting this to "CONTINUE". Passing other values than "CONTINUE" will result in an error.
          enum:
          - COMPLETED
          - STOPPED
          - ROLLED_BACK
          - CONTINUE
          default: CONTINUE
        stopAction:
          $ref: '#/components/schemas/StopActionRO_v1'
      description: A resource object containing data about an ongoing order creation process. Includes information about the status of the order creation and whether additional actions need to be performed before the order creation is finished (e. g. redirects to payment providers).
    OrderDiscountsRO_v1:
      type: object
      properties:
        freeGiftDiscounts:
          type: array
          description: The IDs of all free gift discounts granted on the order.
          readOnly: true
          items:
            type: string
            description: The IDs of all free gift discounts granted on the order.
            readOnly: true
        shippingBasedDiscounts:
          type: array
          description: The IDs of all discounts granted on shipping and handling costs.
          readOnly: true
          items:
            type: string
            description: The IDs of all discounts granted on shipping and handling costs.
            readOnly: true
        valueBasedDiscounts:
          type: array
          description: The IDs of all discounts granted on the order total.
          readOnly: true
          items:
            type: string
            description: The IDs of all discounts granted on the order total.
            readOnly: true
      description: Provides details about the applied discounts.
      readOnly: true
    OrderListCtnrRO_v1:
      type: object
      properties:
        data:
          type: array
          description: The core data of the response object.
          items:
            $ref: '#/components/schemas/OrderRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects. Included via "include" query parameter.
            readOnly: true
          description: Optionally included related data objects. Included via "include" query parameter.
          readOnly: true
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    OrderRO_v1:
      required:
      - basket
      - termsAndConditionsAccepted
      type: object
      properties:
        affiliatePartner:
          type: string
          description: The affiliate partner id of the order.
          readOnly: true
          example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
        affiliateProgram:
          type: string
          description: The affiliate program id of the order.
          readOnly: true
          example: uzMKAB2YvKAAAAFb7DUYRPJ8
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttributeRO_v1'
        basket:
          type: string
          description: The basket (ID) which this order is created from.
          example: b45KeTsBizQBBBFjXFAA6S15
        buckets:
          type: array
          description: The bucket ids of all shipping buckets of an order.
          readOnly: true
          items:
            type: string
            description: The bucket ids of all shipping buckets of an order.
            readOnly: true
        commonShipToAddress:
          type: string
          description: The common ship-to address URN of the order.
          readOnly: true
          example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
        commonShippingMethod:
          type: string
          description: The common shipping method id of the order.
          readOnly: true
          example: STD_5DAY
        costCenter:
          type: string
          description: The cost center id of the order.
          readOnly: true
          example: "511288"
        creationDate:
          type: string
          description: The creation date of the order.
          format: date-time
          readOnly: true
          example: 2019-06-30T13:23:45+02:00
        customer:
          type: string
          description: The order owner customer number.
          readOnly: true
        department:
          type: string
          description: The department name of the order.
          readOnly: true
          example: SALES
        discounts:
          $ref: '#/components/schemas/OrderDiscountsRO_v1'
        documentNumber:
          type: string
          description: The document number of the order.
          readOnly: true
        externalOrderReference:
          type: string
          description: The external order reference id of the order.
          readOnly: true
          example: "30000008899"
        id:
          type: string
          description: The ID of the order.
          readOnly: true
          example: q2QKAEsBiyQAAAFjXFBB6G14
        invoiceToAddress:
          type: string
          description: The invoice-to address URN of the order.
          readOnly: true
          example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
        lineItems:
          type: array
          description: The IDs of all line items of an order.
          readOnly: true
          items:
            type: string
            description: The IDs of all line items of an order.
            readOnly: true
        messageToMerchant:
          type: string
          description: Something what the buyer would like to tell the merchant.
          readOnly: true
          example: Is it possible to send the ordered articles before Christmas?
        orderCreation:
          $ref: '#/components/schemas/OrderCreationRO_v1'
        payments:
          type: array
          description: The payments used to pay the order.
          readOnly: true
          items:
            type: string
            description: The payments used to pay the order.
            readOnly: true
        promotionCodes:
          type: array
          description: The promotion codes of the order.
          readOnly: true
          items:
            type: string
            description: The promotion codes of the order.
            readOnly: true
        purchaseCurrency:
          type: string
          description: The purchase currency of the order.
          readOnly: true
          example: USD
        recurringOrderDocumentNo:
          type: string
          description: The recurring order number.
          readOnly: true
        requisitionDocumentNo:
          type: string
          description: The requisition documentnumber.
          readOnly: true
          example: "00001052"
        status:
          type: string
          description: The localized display name of the order status.
          readOnly: true
          example: in progress
        statusCode:
          type: string
          description: The status code of the order.
          readOnly: true
          example: INPROGRESS
        surcharges:
          $ref: '#/components/schemas/OrderSurchargesRO_v1'
        taxIdentificationNumber:
          type: string
          description: The tax identification number of the buyer/company.
          readOnly: true
          example: "11111111"
        termsAndConditionsAccepted:
          type: boolean
          description: Flag for specifying whether the terms and conditions have been accepted. A value of 'false' will cause the order creation to fail.
        totalProductQuantity:
          type: number
          description: The sum of all quantities of products in the order.
          readOnly: true
          example: 23
        totals:
          $ref: '#/components/schemas/OrderTotalsRO_v1'
        user:
          type: string
          description: The order owner user login.
          readOnly: true
      description: A representation of an order
    OrderSurchargeRO_v1:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/PriceRO_v1'
        name:
          type: string
          description: The name of an element.
          readOnly: true
          example: Fridge Box
        description:
          type: string
          description: The surcharge's localized description.
          readOnly: true
          example: Needs a fridge box for shipping.
        taxes:
          type: array
          description: The taxes applied to the surcharge.
          readOnly: true
          items:
            $ref: '#/components/schemas/TaxItemRO_v1'
      description: Describes a single surcharge incurred to a shipping bucket.
      readOnly: true
    OrderSurchargesRO_v1:
      type: object
      properties:
        bucketSurcharges:
          type: array
          description: All bucket based extra charges arising from surcharges with action type 'bucket'.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderSurchargeRO_v1'
        itemSurcharges:
          type: array
          description: All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderSurchargeRO_v1'
      description: Surcharges that are applied to an order.
      readOnly: true
    OrderTotalsRO_v1:
      type: object
      properties:
        grandTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        paymentCostsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        undiscountedItemTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        undiscountedShippingTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        bucketShippingDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        discountTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        giftingTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        itemShippingDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        itemTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        itemValueDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        orderShippingDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        orderValueDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        salesTaxTotalsByTaxRate:
          type: array
          description: All sales taxes applied to the order, accumulated by their tax rates.
          readOnly: true
          items:
            $ref: '#/components/schemas/TaxItemRO_v1'
        shippingDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        shippingTaxTotalsByTaxRate:
          type: array
          description: All shipping taxes applied to the order, accumulated by their tax rates.
          readOnly: true
          items:
            $ref: '#/components/schemas/TaxItemRO_v1'
        shippingTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        surchargeTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        taxTotalsByTaxRate:
          type: array
          description: All taxes applied to the order, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
          readOnly: true
          items:
            $ref: '#/components/schemas/TaxItemRO_v1'
        valueDiscountsTotal:
          $ref: '#/components/schemas/PriceRO_v1'
      description: Total price values for an order.
      readOnly: true
    ParameterRO_v1:
      type: object
      properties:
        name:
          type: string
          description: The name of an element.
          example: expiryDate
        value:
          type: object
          description: The value of the parameter.
          example: 12/20
      description: A representation of a parameter value.
    PaymentRedirectRO_v1:
      required:
      - cancelUrl
      - failureUrl
      - successUrl
      type: object
      properties:
        cancelUrl:
          type: string
          description: The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders \*orderID\* and \*paymentID\* are available.
          format: uri
          example: https://shop.server/cancel?paymentID=*paymentID*
        failureUrl:
          type: string
          description: The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders \*orderID\* and \*paymentID\* are available.
          format: uri
          example: https://shop.server/failure
        parameters:
          type: array
          description: List of parameters returned in the redirect response from the PSP.
          items:
            $ref: '#/components/schemas/ParameterRO_v1'
        redirectUrl:
          type: string
          description: The URL to be called when redirecting the user to the payment providers page.
          format: uri
          readOnly: true
          example: https://psp-server/pay
        status:
          type: string
          description: The final status of the redirect returned to the shop.
          example: SUCCESS
          enum:
          - SUCCESS
          - CANCEL
          - FAILURE
        successUrl:
          type: string
          description: The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders \*orderID\* and \*paymentID\* are available.
          format: uri
          example: https://shop.server/success?orderID=*orderID*
      description: 'Describes a payment redirect. Note: Beta version - This class
        can still be subject of change!'
    PriceRO_v1:
      type: object
      properties:
        gross:
          $ref: '#/components/schemas/MoneyRO_v1'
        net:
          $ref: '#/components/schemas/MoneyRO_v1'
        tax:
          $ref: '#/components/schemas/MoneyRO_v1'
      description: Describes a price. A price has a monetary net, gross and tax value.
      readOnly: true
    QuantityAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a quantity attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/QuantityRO_v1'
    QuantityRO_v1:
      required:
      - value
      type: object
      properties:
        unit:
          type: string
          description: The quantity's unit code.
          example: kg
        value:
          type: number
          description: The quantity's value.
          example: 10
      description: A quantity of a business entity.
    StopActionRO_v1:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: 'The type of the object. This is normally a **constant** that
            can be used to differentiate objects by their type. '
          readOnly: true
      description: A representation of a stop action. A stop action is an action that needs to be performed before a certain process (e. g. creation of an order) can be continued.
      readOnly: true
      discriminator:
        propertyName: type
        mapping:
          Redirect: '#/components/schemas/StopActionRedirectRO_v1'
          Workflow: '#/components/schemas/StopActionWorkflowRO_v1'
      oneOf:
      - $ref: '#/components/schemas/StopActionRedirectRO_v1'
      - $ref: '#/components/schemas/StopActionWorkflowRO_v1'
    StopActionRedirectRO_v1:
      required:
      - redirectUrl
      - type
      type: object
      description: A redirect stop action. Contains an URL (e. g. to a payment service provider) that needs to be visited before the stopped process can be continued.
      allOf:
      - $ref: '#/components/schemas/StopActionRO_v1'
      - type: object
        properties:
          redirectUrl:
            type: string
            description: The redirect URL that needs to be visited before the stopped process can be continued.
            format: uri
            readOnly: true
    StopActionWorkflowRO_v1:
      required:
      - exitReason
      - type
      type: object
      description: A workflow stop action. This indicates that an external workflow (e. g. order approval) needs to be triggered before the stopped process can continue.
      allOf:
      - $ref: '#/components/schemas/StopActionRO_v1'
      - type: object
        properties:
          exitReason:
            type: string
            description: The reason stating why the process was stopped and which workflow needs to be triggered before the stopped process can continue.
            readOnly: true
            example: approval_workflow
    StringAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a string attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: string
            description: The string attribute value.
    TaxItemRO_v1:
      required:
      - calculatedTax
      - effectiveTaxRate
      type: object
      properties:
        calculatedTax:
          $ref: '#/components/schemas/MoneyRO_v1'
        effectiveTaxRate:
          type: number
          description: The effective rate used to calculate the tax.
        jurisdiction:
          $ref: '#/components/schemas/JurisdictionRO_v1'
        nonTaxableAmount:
          $ref: '#/components/schemas/MoneyRO_v1'
        situs:
          type: string
          description: The situs/place of taxation.
          readOnly: true
          example: DESTINATION
          enum:
          - NULL
          - ADMINISTRATIVE_DESTINATION
          - ADMINISTRATIVE_ORIGIN
          - DESTINATION
          - ORIGIN
        taxableAmount:
          $ref: '#/components/schemas/MoneyRO_v1'
      description: Represents a single tax item.
      readOnly: true
    TextAttributeRO_v1:
      required:
      - name
      - type
      - value
      type: object
      description: A representation of a text attribute.
      allOf:
      - $ref: '#/components/schemas/AttributeRO_v1Object'
      - type: object
        properties:
          value:
            type: string
            description: The text attribute value.
    OrderCtnrRO_v1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrderRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects. Included via "include" query parameter.
            readOnly: true
          description: Optionally included related data objects. Included via "include" query parameter.
          readOnly: true
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    AttributeCtnrRO_v1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AttributeRO_v1Object'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects.
          description: Optionally included related data objects.
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    AttributeRO_v1Object:
      required:
      - name
      - type
      type: object
      properties:
        name:
          type: string
          description: The name of an element.
        type:
          type: string
          description: 'The type of the object. This is normally a **constant** that
            can be used to differentiate objects by their type. '
          enum:
          - Boolean
          - Date
          - Decimal
          - Double
          - Integer
          - Long
          - Money
          - Quantity
          - String
          - Text
          - MultipleBoolean
          - MultipleDate
          - MultipleDecimal
          - MultipleDouble
          - MultipleInteger
          - MultipleLong
          - MultipleString
        value:
          type: object
      description: A representation of an attribute.
      discriminator:
        propertyName: type
        mapping:
          Boolean: '#/components/schemas/BooleanAttributeRO_v1'
          Date: '#/components/schemas/DateAttributeRO_v1'
          Decimal: '#/components/schemas/DecimalAttributeRO_v1'
          Double: '#/components/schemas/DoubleAttributeRO_v1'
          Integer: '#/components/schemas/IntegerAttributeRO_v1'
          Long: '#/components/schemas/LongAttributeRO_v1'
          Money: '#/components/schemas/MoneyAttributeRO_v1'
          Quantity: '#/components/schemas/QuantityAttributeRO_v1'
          String: '#/components/schemas/StringAttributeRO_v1'
          Text: '#/components/schemas/TextAttributeRO_v1'
          MultipleBoolean: '#/components/schemas/MultipleBooleanAttributeRO_v1'
          MultipleDate: '#/components/schemas/MultipleDateAttributeRO_v1'
          MultipleDecimal: '#/components/schemas/MultipleDecimalAttributeRO_v1'
          MultipleDouble: '#/components/schemas/MultipleDoubleAttributeRO_v1'
          MultipleInteger: '#/components/schemas/MultipleIntegerAttributeRO_v1'
          MultipleLong: '#/components/schemas/MultipleLongAttributeRO_v1'
          MultipleString: '#/components/schemas/MultipleStringAttributeRO_v1'
      oneOf:
      - $ref: '#/components/schemas/BooleanAttributeRO_v1'
      - $ref: '#/components/schemas/DateAttributeRO_v1'
      - $ref: '#/components/schemas/DecimalAttributeRO_v1'
      - $ref: '#/components/schemas/DoubleAttributeRO_v1'
      - $ref: '#/components/schemas/IntegerAttributeRO_v1'
      - $ref: '#/components/schemas/LongAttributeRO_v1'
      - $ref: '#/components/schemas/MoneyAttributeRO_v1'
      - $ref: '#/components/schemas/QuantityAttributeRO_v1'
      - $ref: '#/components/schemas/StringAttributeRO_v1'
      - $ref: '#/components/schemas/TextAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleBooleanAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleDateAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleDecimalAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleDoubleAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleIntegerAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleLongAttributeRO_v1'
      - $ref: '#/components/schemas/MultipleStringAttributeRO_v1'
    AttributeListCtnrRO_v1:
      type: object
      properties:
        data:
          type: array
          description: The core data of the response object.
          items:
            $ref: '#/components/schemas/AttributeRO_v1Object'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects.
          description: Optionally included related data objects.
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    OrderLineItemListCtnrRO_v1:
      type: object
      properties:
        data:
          type: array
          description: The core data of the response object.
          items:
            $ref: '#/components/schemas/OrderLineItemRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects. Included via "include" query parameter.
            readOnly: true
          description: Optionally included related data objects. Included via "include" query parameter.
          readOnly: true
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    OrderLineItemPricingRO_v1:
      type: object
      properties:
        giftingTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        price:
          $ref: '#/components/schemas/PriceRO_v1'
        salesTaxTotal:
          $ref: '#/components/schemas/MoneyRO_v1'
        shippingRebatesTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        shippingTaxTotal:
          $ref: '#/components/schemas/MoneyRO_v1'
        singleBasePrice:
          $ref: '#/components/schemas/PriceRO_v1'
        undiscountedPrice:
          $ref: '#/components/schemas/PriceRO_v1'
        undiscountedShippingTotal:
          $ref: '#/components/schemas/PriceRO_v1'
        undiscountedSingleBasePrice:
          $ref: '#/components/schemas/PriceRO_v1'
        valueRebatesTotal:
          $ref: '#/components/schemas/PriceRO_v1'
      description: total price values of a line item
      readOnly: true
    OrderLineItemRO_v1:
      required:
      - product
      - quantity
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttributeRO_v1'
        description:
          type: string
          description: The description for the product line item.
          readOnly: true
          example: "20"
        desiredDelivery:
          type: string
          description: The desired delivery date for the Item.
          format: date
          readOnly: true
          example: 2001-07-04
        discounts:
          type: array
          description: The IDs of the discounts applied to the item pricing.
          readOnly: true
          items:
            type: string
            description: The IDs of the discounts applied to the item pricing.
            readOnly: true
        displayName:
          type: string
          description: The display name of the product line item.
          readOnly: true
          example: Acer C20 silver edition
        freeGift:
          type: boolean
          description: Flag indicating that this product line item is a free gift and  has been automatically placed in the line item container.
          readOnly: true
          example: false
        fulfillmentStatus:
          type: string
          description: The fulfillment status of this line item.
          readOnly: true
          example: NEW
        giftMessage:
          type: string
          description: Additional gift message for this the line item.
          readOnly: true
        giftWrap:
          type: string
          description: Additional gift wrapping for this the line item.
          readOnly: true
        hiddenGift:
          type: boolean
          description: Flag indicating that this product line item is a free gift, that will not be displayed in line item container.
          readOnly: true
          example: false
        id:
          type: string
          description: The line item's unique identifier.
          readOnly: true
        order:
          type: string
          description: The order this line item belongs to.
          readOnly: true
          example: yUQKAEsBeeoAAAFl9vhJwIZc
        position:
          type: integer
          description: The position of the item in the order.
          format: int32
          readOnly: true
        pricing:
          $ref: '#/components/schemas/OrderLineItemPricingRO_v1'
        product:
          type: string
          description: The product represented as stock keeping unit (SKU).
          readOnly: true
          example: "5079747"
        quantity:
          $ref: '#/components/schemas/QuantityRO_v1'
        quote:
          type: string
          description: The quote this item was created from.
          readOnly: true
          example: Qu0T3MgoyuMAx9Es2sx0Ue1
        shipToAddress:
          type: string
          description: The ship-to address URN for this line item.
          readOnly: true
          example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
        shippingMethod:
          type: string
          description: The shipping method id for this line item.
          readOnly: true
          example: STD_5DAY
        surcharges:
          type: array
          description: Details about additional surcharges applied to the item.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderSurchargeRO_v1'
        thumbnail:
          type: string
          description: The thumbnail uri of the Product.
          readOnly: true
          example: /INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
        warranty:
          type: string
          description: A warranty assigned to the line item.
          readOnly: true
      description: Describes a line item that is part of an order.
    OrderLineItemCtnrRO_v1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrderLineItemRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects. Included via "include" query parameter.
            readOnly: true
          description: Optionally included related data objects. Included via "include" query parameter.
          readOnly: true
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    OrderShippingBucketListCtnrRO_v1:
      type: object
      properties:
        data:
          type: array
          description: The core data of the response object.
          items:
            $ref: '#/components/schemas/OrderShippingBucketRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects. Included via "include" query parameter.
            readOnly: true
          description: Optionally included related data objects. Included via "include" query parameter.
          readOnly: true
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    OrderShippingBucketRO_v1:
      type: object
      properties:
        deliveryTimeMax:
          type: object
          properties:
            years:
              type: integer
              format: int32
            months:
              type: integer
              format: int32
            days:
              type: integer
              format: int32
            zero:
              type: boolean
            chronology:
              type: object
              properties:
                calendarType:
                  type: string
                id:
                  type: string
            negative:
              type: boolean
            units:
              type: array
              items:
                type: object
                properties:
                  duration:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      negative:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                  dateBased:
                    type: boolean
                  timeBased:
                    type: boolean
                  durationEstimated:
                    type: boolean
          description: The maximum time the delivery will take based on the chosen shipping method (in ISO-8601 period format).
          readOnly: true
          example: P7D
        deliveryTimeMin:
          type: object
          properties:
            years:
              type: integer
              format: int32
            months:
              type: integer
              format: int32
            days:
              type: integer
              format: int32
            zero:
              type: boolean
            chronology:
              type: object
              properties:
                calendarType:
                  type: string
                id:
                  type: string
            negative:
              type: boolean
            units:
              type: array
              items:
                type: object
                properties:
                  duration:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      negative:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                  dateBased:
                    type: boolean
                  timeBased:
                    type: boolean
                  durationEstimated:
                    type: boolean
          description: The minimum time the delivery will take based on the chosen shipping method (in ISO-8601 period format).
          readOnly: true
          example: P3D
        discounts:
          type: array
          description: The IDs of the discounts applied to the bucket totals.
          readOnly: true
          items:
            type: string
            description: The IDs of the discounts applied to the bucket totals.
            readOnly: true
        id:
          type: string
          description: The ID of the bucket.
          readOnly: true
          example: "54489489212"
        lineItems:
          type: array
          description: The ids of all line items which are associated with this bucket.
          readOnly: true
          items:
            type: string
            description: The ids of all line items which are associated with this bucket.
            readOnly: true
        order:
          type: string
          description: The order this shipping bucket belongs to.
          readOnly: true
          example: yUQKAEsBeeoAAAFl9vhJwIZc
        shipToAddress:
          type: string
          description: The ship-to address URN for this bucket.
          readOnly: true
          example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
        shippingCosts:
          $ref: '#/components/schemas/PriceRO_v1'
        shippingMethod:
          type: string
          description: The shipping method id for this bucket.
          readOnly: true
          example: STD_5DAY
        surcharges:
          type: array
          description: All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderSurchargeRO_v1'
      description: Describes a shipping bucket.
    OrderShippingBucketCtnrRO_v1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/OrderShippingBucketRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects. Included via "include" query parameter.
            readOnly: true
          description: Optionally included related data objects. Included via "include" query parameter.
          readOnly: true
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    PaymentCtnrRO_v1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PaymentRO_v1'
        errors:
          type: array
          description: List of errors that occurred in relation to the request.
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        included:
          type: object
          additionalProperties:
            type: object
            description: Optionally included related data objects.
          description: Optionally included related data objects.
        infos:
          type: array
          description: List of informations regarding to the request (e.g. value adjustments).
          readOnly: true
          items:
            $ref: '#/components/schemas/FeedbackRO_v1'
        links:
          type: object
          additionalProperties:
            type: object
            description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
            readOnly: true
          description: Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
          readOnly: true
    PaymentRO_v1:
      required:
      - paymentInstrument
      type: object
      properties:
        baseAmount:
          $ref: '#/components/schemas/MoneyRO_v1'
        id:
          type: string
          description: The ID of the payment.
          readOnly: true
          example: AAFjXFq2QKAEsBiyQABB6G14
        openTender:
          type: boolean
          description: Whether or not the payment is an 'open-tender' payment.
          readOnly: true
        paymentCosts:
          $ref: '#/components/schemas/PriceRO_v1'
        paymentInstrument:
          type: string
          description: The reference to the payment instrument that was selected for this payment.
          example: c2UKAEsBar8AAAFmxYVBTOiI
        paymentMethod:
          type: string
          description: The reference to the payment method that was used for this payment.
          readOnly: true
          example: ISH_INVOICE
        redirect:
          $ref: '#/components/schemas/PaymentRedirectRO_v1'
        redirectRequired:
          type: boolean
          description: Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
          readOnly: true
        status:
          type: string
          description: The localized display name of the payment status.
          readOnly: true
          example: Partially captured
        totalAmount:
          $ref: '#/components/schemas/MoneyRO_v1'
      description: A payment assigned to the basket/order to pay the bill with.
  responses:
    200:
      description: OK
    201:
      description: Created
    202:
      description: Accepted
    204:
      description: No Content
    205:
      description: Reset Content
    206:
      description: Partial Content
    301:
      description: Moved Permanently
    302:
      description: Found
    303:
      description: See Other
    304:
      description: Not Modified
    305:
      description: Use Proxy
    307:
      description: Temporary 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
    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
  parameters:
    loc:
      name: loc
      in: path
      description: The locale ID (submitted as optional matrix parameter ```;loc=<LOCALE>```). If omitted, the site's or user's default locale is used.
      required: false
      style: matrix
      schema:
        type: string
        description: The locale ID (submitted as optional matrix parameter ```;loc=<LOCALE>```). If omitted, the site's or user's default locale is used.
        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
        STD:
          description: São Tomé / Príncipe Dobra
          value: STD
        MXN:
          description: Mexican Peso
          value: MXN
        LVL:
          description: Latvian Lats
          value: LVL
        SCR:
          description: Seychelles Rupee
          value: SCR
        CDF:
          description: Congolese Franc
          value: CDF
        GTQ:
          description: Guatemalan Quetzal
          value: GTQ
        BBD:
          description: Barbados Dollar
          value: BBD
        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
        GMD:
          description: Gambian Dalasi
          value: GMD
        CUP:
          description: Cuban Peso
          value: CUP
        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
        PGK:
          description: Papua New Guinean Kina
          value: PGK
        OMR:
          description: Omani Rial
          value: OMR
        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
        XPF:
          description: CFP Franc
          value: XPF
        UZS:
          description: Uzbekistani Som
          value: UZS
        THB:
          description: Thai Baht
          value: THB
        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
        JMD:
          description: Jamaican Dollar
          value: JMD
        ISK:
          description: Iceland Krona
          value: ISK
        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
        VUV:
          description: Vanuatu Vatu
          value: VUV
        VEF:
          description: Venezuelan Bolivar Fuerte
          value: VEF
        SOS:
          description: Somali Shilling
          value: SOS
        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
        ITL:
          description: Italian Lira
          value: ITL
        HRK:
          description: Croatian Kuna
          value: HRK
        CHF:
          description: Swiss Franc
          value: CHF
        ATS:
          description: Austrian Schilling
          value: ATS
        DJF:
          description: Djibouti Franc
          value: DJF
        ALL:
          description: Albanian Lek
          value: ALL
        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
        KPW:
          description: North Korean Won
          value: KPW
        GYD:
          description: Guyanese Dollar
          value: GYD
        GHS:
          description: Ghanaian Cedi
          value: GHS
        MDL:
          description: Moldovan Leu
          value: MDL
        KHR:
          description: Cambodian Riel
          value: KHR
        BOB:
          description: Boliviano
          value: BOB
        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
        TRY:
          description: Turkish Lira
          value: TRY
        SHP:
          description: Saint Helena Pound
          value: SHP
        LBP:
          description: Lebanese Pound
          value: LBP
        CYP:
          description: Cyprus Pound
          value: CYP
        TJS:
          description: Tajikistani Somoni
          value: TJS
        JOD:
          description: Jordanian Dinar
          value: JOD
        HKD:
          description: Hong Kong Dollar
          value: HKD
        AED:
          description: United Arab Emirates Dirham
          value: AED
        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
        MMK:
          description: Kyat
          value: MMK
        EEK:
          description: Estonian Kroon
          value: EEK
        MUR:
          description: Mauritian Rupee
          value: MUR
        SYP:
          description: Syrian Pound
          value: SYP
        NOK:
          description: Norwegian Krone
          value: NOK
        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
        IEP:
          description: Irish Pound
          value: IEP
        CZK:
          description: Czech Koruna
          value: CZK
        CRC:
          description: Costa Rican Colon
          value: CRC
        PKR:
          description: Pakistani Rupee
          value: PKR
        GRD:
          description: Greek Drachma
          value: GRD
        XCD:
          description: East Carribean Dollar
          value: XCD
        HTG:
          description: Haitian Gourde
          value: HTG
        ANG:
          description: Netherlands Antillian Guilder
          value: ANG
        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
        SZL:
          description: Swazi Lilangeni
          value: SZL
        SRD:
          description: Surinam Dollar
          value: SRD
        LTL:
          description: Lithuanian Litas
          value: LTL
        TTD:
          description: Trinidad and Tobago Dollar
          value: TTD
        SAR:
          description: Saudi Riyal
          value: SAR
        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
        KRW:
          description: South Korean Won
          value: KRW
        AWG:
          description: Aruban Florin
          value: AWG
        NPR:
          description: Nepalese Rupee
          value: NPR
        MNT:
          description: Mongolian Tugrik
          value: MNT
        JPY:
          description: Japanese Yen
          value: JPY
        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
        DEM:
          description: Deutsche Mark
          value: DEM
        BZD:
          description: Belize Dollar
          value: BZD
        BAM:
          description: Convertible Marks
          value: BAM
        MOP:
          description: Macanese Pataca
          value: MOP
        EGP:
          description: Egyptian Pound
          value: EGP
        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
        WST:
          description: Samoan Tala
          value: WST
        NZD:
          description: New Zealand Dollar
          value: NZD
        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 personal group identifier (submitted as matrix parameter ```;pgid=<PGID>```).
      required: false
      style: matrix
      schema:
        type: string
        description: The personal group identifier (submitted as matrix parameter ```;pgid=<PGID>```).
        example: FUOGrzQ_VjORpGaN8DRGmLLE0000
      example: FUOGrzQ_VjORpGaN8DRGmLLE0000
    spgid:
      name: spgid
      in: path
      description: The secure personal group identifier (submitted as matrix parameter ```;spgid=<PGID>```).
      required: false
      style: matrix
      schema:
        type: string
        description: The secure personal group identifier (submitted as matrix parameter ```;spgid=<PGID>```).
        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_v100
x-origin-class: com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.order.OrderListResource,com.intershop.sellside.rest.common.capi.resource.order.OrderResource,com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource,com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemItemResource,com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemItemResource,com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource,com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource,com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource,com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource,com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource
x-apiMediaType: application/vnd.intershop.order.v1+json
x-strict-apiMediaType: "true"