openapi: 3.0.1
info:
  title: Subscription (Recurring Order)
  description: |
    The Intershop Recurring Order API contains operations for managing a recipient's recurring orders and related payment information.
  contact:
    name: Intershop Communications AG
    url: http://intershop.com
  version: 1.0.0
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: smb-responsive
tags:
- name: General
  description: "This section covers operations for managing recurring orders. This\
    \ includes retrieving a list of recurring orders, details for a specific recurring\
    \ order and activating/deactivating a specific recurring order.\n"
  x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
- name: Payment
  description: "This section covers operations for managing payments for recurring\
    \ orders. This includes retrieving, adding and removing payments.\n"
  x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
paths:
  /customers/{CustomerKey}/recurringorders:
    get:
      tags:
      - General
      summary: Returns a list of recurring orders of the given individual customer
      description: "This operation returns a list of links of all recurring orders\
        \ for the customer.\n\nNote: This operation requires account administrator\
        \ permissions for B2B.\n"
      operationId: getRecurringOrders_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      responses:
        "200":
          description: OK - The recurring orders for the given customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderLinkROResourceCollection'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderLinkROResourceCollection'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer could not be found.
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
             - error.recurring_orders.disabled
        "503":
          description: Service unavailable - The Microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource.getRecurringOrders()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
  /customers/{CustomerKey}/recurringorders/{RecurringOrderKey}:
    get:
      tags:
      - General
      summary: Returns details about a customer's recurring order
      description: "This operation returns details about the recurring order to the\
        \ client.\n\nNote: This operation requires account administrator permissions\
        \ for B2B.\n\nThe recurrence Interval is defined as Java Period Object that\
        \ supports ISO 8601. It provides numerous ways to set the interval.\nThe string\
        \ always starts with a 'P' for period. The interval can contain a number of\
        \ years (Y), months (M) weeks (W) or Days (D) or any combination of them.\n\
        The number is placed in front of the unit. Weeks are transformed to days by\
        \ multiplying with 7 -> (P4W \\= P28D).\n"
      operationId: getRecurringOrder_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The recurring order with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header 'error-key':
             - error.recurring_orders.disabled
        "503":
          description: Service unavailable - The microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.getRecurringOrder()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
    put:
      tags:
      - General
      summary: Updates a recurring order
      description: |
        This operation updates the selected recurring order.

        Only activation and deactivation are supported. Expired recurring orders cannot be set to active.
      operationId: updateRecurringOrder_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRecurringOrderRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/UpdateRecurringOrderRO'
      responses:
        "200":
          description: OK - The updated recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
        "409":
          description: |-
            Conflict - The recurring order cannot be enabled. Possible values for header value 'error-key':
             - error.recurring_orders.enable-not-possible
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
             - error.recurring-orders.disabled
        "503":
          description: Service unavailable - The microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.updateRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
  /customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments:
    get:
      tags:
      - Payment
      summary: Returns payments of recurring order
      description: |
        This operation returns a list of all selected payments for the recurring order.
      operationId: getRecurringOrderPayments_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The payments for the given recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkROResourceCollectionRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/LinkROResourceCollectionRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the basket\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPayments()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
    post:
      tags:
      - Payment
      summary: Adds payment to recurring order
      description: This operation adds a payment method to the recurring order. A
        registered payment method can be referenced via ID (for payments that have
        been created with POST /customers/-/payments).
      operationId: addPaymentToRecurringOrder_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRO'
      responses:
        "201":
          description: Created - The payment was added successfully.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the basket\
            \ could not be found. Possible values for header error-key:\n - basket.basket_not_found.error"
        "400":
          description: "Bad request - The payment instrument with this ID could not\
            \ be found. Possible values for header error-key:\n - shopping_cart.payment.paymentdata.error\
            \ (e.g., wrong giftcard number)\n - shopping_cart.payment.missing_fields.error\n\
            \ - shopping_cart.payment.invalid_fields.error\n - shopping_cart.payment.name.error\
            \ (Payment method not found)\n - shopping_cart.payment.dublicate.error\n\
            \ - shopping_cart.payment.available.error (also thrown if basket contains\
            \ NO items)"
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.addPaymentToRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
    options:
      tags:
      - Payment
      summary: Returns all payment options of recurring order
      description: |
        This operation returns all available payment methods and their parameters available for the recurring order.
      operationId: getRecurringOrderPaymentOptions_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The payment options for the given recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentOptionsRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentOptionsRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPaymentOptions()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
  /customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}:
    get:
      tags:
      - Payment
      summary: Returns payment details of recurring order payments
      description: |
        This Operation returns details about the selected payment method for the recurring order.
      operationId: getRecurringOrderPayment_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      responses:
        "200":
          description: OK - The payment with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.getRecurringOrderPayment()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource
    delete:
      tags:
      - Payment
      summary: Removes payment from recurring order
      description: This operation removes the selected payment method from the recurring
        order payments.
      operationId: removePaymentFromRecurringOrder_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      responses:
        "204":
          description: No content - The payment was successfully deleted.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.removePaymentFromRecurringOrder()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource
  /customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect:
    put:
      tags:
      - Payment
      summary: Creates URL for redirect to the payment provider
      description: "The REST client sends the return URLs to the system, so that the\
        \ redirect URL for the payment service provider can be created. This redirect\
        \ URL will be sent as response to the REST client so that the client can process\
        \ the redirect action. After that, the user will be redirected back to his\
        \ REST client based on the return URLs.\n\nNote: This operation requires authentication\
        \ with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).\n"
      operationId: createRecurringOrderPaymentRedirectURL_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRedirectRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRedirectRO'
      responses:
        "201":
          description: Created - The redirect URL was successfully created.
        "400":
          description: Bad request - The payment service does not support redirect
            capability.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
    post:
      tags:
      - Payment
      summary: Sends transaction details after redirect to the shop system
      description: "When the user has processed a payment transaction at the payment\
        \ provider's system, he will be redirected back to the REST client. Regardless\
        \ of the outcome of this transaction, the return redirect contains various\
        \ payment transaction attributes which must be transferred from the REST client\
        \ back to the shop system to process the payment transaction. The redirect\
        \ POST request transfers this data from the REST client into the shop system\
        \ so that the payment transaction can be activated there. For instance:\n\n\
        - Transaction ID\n\n- Transaction status\n\n- etc\n\nNote: This operation\
        \ requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE',\
        \ only in B2B applications).\n"
      operationId: addRecurringOrderPaymentRedirectResponseData_1
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRedirectResponseRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRedirectResponseRO'
      responses:
        "200":
          description: OK- The payment transaction was activated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentRO'
        "400":
          description: Bad request - The payment service does not support redirect
            capability.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
  /customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders:
    get:
      tags:
      - General
      summary: Returns a list of recurring orders of the given individual customer
      description: "This operation returns a list of links of all recurring orders\
        \ for the customer.\n\nNote: This operation requires account administrator\
        \ permissions for B2B.\n"
      operationId: getRecurringOrders_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      responses:
        "200":
          description: OK - The recurring orders for the given customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderLinkROResourceCollection'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderLinkROResourceCollection'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer could not be found.
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
             - error.recurring_orders.disabled
        "503":
          description: Service unavailable - The Microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource.getRecurringOrders()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
  /customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}:
    get:
      tags:
      - General
      summary: Returns details about a customer's recurring order
      description: "This operation returns details about the recurring order to the\
        \ client.\n\nNote: This operation requires account administrator permissions\
        \ for B2B.\n\nThe recurrence Interval is defined as Java Period Object that\
        \ supports ISO 8601. It provides numerous ways to set the interval.\nThe string\
        \ always starts with a 'P' for period. The interval can contain a number of\
        \ years (Y), months (M) weeks (W) or Days (D) or any combination of them.\n\
        The number is placed in front of the unit. Weeks are transformed to days by\
        \ multiplying with 7 -> (P4W \\= P28D).\n"
      operationId: getRecurringOrder_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The recurring order with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header 'error-key':
             - error.recurring_orders.disabled
        "503":
          description: Service unavailable - The microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.getRecurringOrder()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
    put:
      tags:
      - General
      summary: Updates a recurring order
      description: |
        This operation updates the selected recurring order.

        Only activation and deactivation are supported. Expired recurring orders cannot be set to active.
      operationId: updateRecurringOrder_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRecurringOrderRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/UpdateRecurringOrderRO'
      responses:
        "200":
          description: OK - The updated recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
        "409":
          description: |-
            Conflict - The recurring order cannot be enabled. Possible values for header value 'error-key':
             - error.recurring_orders.enable-not-possible
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
             - error.recurring-orders.disabled
        "503":
          description: Service unavailable - The microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.updateRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
  /customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}/payments:
    get:
      tags:
      - Payment
      summary: Returns payments of recurring order
      description: |
        This operation returns a list of all selected payments for the recurring order.
      operationId: getRecurringOrderPayments_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The payments for the given recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkROResourceCollectionRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/LinkROResourceCollectionRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the basket\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPayments()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
    post:
      tags:
      - Payment
      summary: Adds payment to recurring order
      description: This operation adds a payment method to the recurring order. A
        registered payment method can be referenced via ID (for payments that have
        been created with POST /customers/-/payments).
      operationId: addPaymentToRecurringOrder_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRO'
      responses:
        "201":
          description: Created - The payment was added successfully.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the basket\
            \ could not be found. Possible values for header error-key:\n - basket.basket_not_found.error"
        "400":
          description: "Bad request - The payment instrument with this ID could not\
            \ be found. Possible values for header error-key:\n - shopping_cart.payment.paymentdata.error\
            \ (e.g., wrong giftcard number)\n - shopping_cart.payment.missing_fields.error\n\
            \ - shopping_cart.payment.invalid_fields.error\n - shopping_cart.payment.name.error\
            \ (Payment method not found)\n - shopping_cart.payment.dublicate.error\n\
            \ - shopping_cart.payment.available.error (also thrown if basket contains\
            \ NO items)"
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.addPaymentToRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
    options:
      tags:
      - Payment
      summary: Returns all payment options of recurring order
      description: |
        This operation returns all available payment methods and their parameters available for the recurring order.
      operationId: getRecurringOrderPaymentOptions_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The payment options for the given recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentOptionsRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentOptionsRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPaymentOptions()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
  /customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}:
    get:
      tags:
      - Payment
      summary: Returns payment details of recurring order payments
      description: |
        This Operation returns details about the selected payment method for the recurring order.
      operationId: getRecurringOrderPayment_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      responses:
        "200":
          description: OK - The payment with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.getRecurringOrderPayment()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource
    delete:
      tags:
      - Payment
      summary: Removes payment from recurring order
      description: This operation removes the selected payment method from the recurring
        order payments.
      operationId: removePaymentFromRecurringOrder_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      responses:
        "204":
          description: No content - The payment was successfully deleted.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.removePaymentFromRecurringOrder()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource
  ? /customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect
  : put:
      tags:
      - Payment
      summary: Get return-URLs from REST client for payment provider redirect
      description: "The REST client sends the return URLs to the system, so that the\
        \ redirect URL for the payment service provider can be created. This redirect\
        \ URL will be sent as response to the REST client so that the client can process\
        \ the redirect action. After that, the user will be redirected back to his\
        \ REST client based on the return URLs.\n\nNote: This operation requires authentication\
        \ with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).\n"
      operationId: createRecurringOrderPaymentRedirectURL_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRedirectRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRedirectRO'
      responses:
        "201":
          description: Created - The redirect URL was successfully created.
        "400":
          description: Bad request - The payment service does not support redirect
            capability.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
    post:
      tags:
      - Payment
      summary: Get transaction details after redirect before checkout
      description: "When the user has processed a payment transaction at the payment\
        \ provider's system, he will be redirected back to the REST client. Regardless\
        \ of the outcome of this transaction, the return redirect contains various\
        \ payment transaction attributes which must be transferred from the REST client\
        \ back to the shop system to process the payment transaction. The redirect\
        \ POST request transfers this data from the REST client into the shop system\
        \ so that the payment transaction can be activated there. For instance:\n\n\
        - Transaction ID\n\n- Transaction status\n\n- etc\n\nNote: This operation\
        \ requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE',\
        \ only in B2B applications).\n"
      operationId: addRecurringOrderPaymentRedirectResponseData_2
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
      - name: CustomerItemUserKey
        in: path
        description: The user ID
        required: true
        schema:
          type: string
          description: The user ID
          example: pmiller@test.intershop.de
        example: pmiller@test.intershop.de
        x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRedirectResponseRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRedirectResponseRO'
      responses:
        "200":
          description: OK- The payment transaction was activated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentRO'
        "400":
          description: Bad request - The payment service does not support redirect
            capability.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
  /privatecustomers/{CustomerKey}/recurringorders:
    get:
      tags:
      - General
      summary: Returns a list of recurring orders of the given individual customer
      description: "This operation returns a list of links of all recurring orders\
        \ for the customer.\n\nNote: This operation requires account administrator\
        \ permissions for B2B.\n"
      operationId: getRecurringOrders
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      responses:
        "200":
          description: OK - The recurring orders for the given customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderLinkROResourceCollection'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderLinkROResourceCollection'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer could not be found.
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
             - error.recurring_orders.disabled
        "503":
          description: Service unavailable - The Microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource.getRecurringOrders()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
  /privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}:
    get:
      tags:
      - General
      summary: Returns details about a customer's recurring order
      description: "This operation returns details about the recurring order to the\
        \ client.\n\nNote: This operation requires account administrator permissions\
        \ for B2B.\n\nThe recurrence Interval is defined as Java Period Object that\
        \ supports ISO 8601. It provides numerous ways to set the interval.\nThe string\
        \ always starts with a 'P' for period. The interval can contain a number of\
        \ years (Y), months (M) weeks (W) or Days (D) or any combination of them.\n\
        The number is placed in front of the unit. Weeks are transformed to days by\
        \ multiplying with 7 -> (P4W \\= P28D).\n"
      operationId: getRecurringOrder
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The recurring order with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header 'error-key':
             - error.recurring_orders.disabled
        "503":
          description: Service unavailable - The microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.getRecurringOrder()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
    put:
      tags:
      - General
      summary: Updates a recurring order
      description: |
        This operation updates the selected recurring order.

        Only activation and deactivation are supported. Expired recurring orders cannot be set to active.
      operationId: updateRecurringOrder
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRecurringOrderRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/UpdateRecurringOrderRO'
      responses:
        "200":
          description: OK - The updated recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/RecurringOrderRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
        "409":
          description: |-
            Conflict - The recurring order cannot be enabled. Possible values for header value 'error-key':
             - error.recurring_orders.enable-not-possible
        "501":
          description: |-
            Not implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
             - error.recurring-orders.disabled
        "503":
          description: Service unavailable - The microservice is not available and/or
            cannot be discovered.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.updateRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource
  /privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments:
    get:
      tags:
      - Payment
      summary: Returns payments of recurring order
      description: |
        This operation returns a list of all selected payments for the recurring order.
      operationId: getRecurringOrderPayments
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The payments for the given recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkROResourceCollectionRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/LinkROResourceCollectionRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the basket\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPayments()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
    post:
      tags:
      - Payment
      summary: Adds payment to recurring order
      description: This operation adds a payment method to the recurring order. A
        registered payment method can be referenced via ID (for payments that have
        been created with POST /customers/-/payments).
      operationId: addPaymentToRecurringOrder
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRO'
      responses:
        "201":
          description: Created - The payment was added successfully.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the basket\
            \ could not be found. Possible values for header error-key:\n - basket.basket_not_found.error"
        "400":
          description: "Bad request - The payment instrument with this ID could not\
            \ be found. Possible values for header error-key:\n - shopping_cart.payment.paymentdata.error\
            \ (e.g., wrong giftcard number)\n - shopping_cart.payment.missing_fields.error\n\
            \ - shopping_cart.payment.invalid_fields.error\n - shopping_cart.payment.name.error\
            \ (Payment method not found)\n - shopping_cart.payment.dublicate.error\n\
            \ - shopping_cart.payment.available.error (also thrown if basket contains\
            \ NO items)"
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.addPaymentToRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
    options:
      tags:
      - Payment
      summary: Returns all payment options of recurring order
      description: |
        This operation returns all available payment methods and their parameters available for the recurring order.
      operationId: getRecurringOrderPaymentOptions
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      responses:
        "200":
          description: OK - The payment options for the given recurring order.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentOptionsRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentOptionsRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: Not found - The customer or the recurring order could not be
            found.
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPaymentOptions()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
  /privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}:
    get:
      tags:
      - Payment
      summary: Returns payment details of recurring order payments
      description: |
        This Operation returns details about the selected payment method for the recurring order.
      operationId: getRecurringOrderPayment
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      responses:
        "200":
          description: OK - The payment with the given ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentRO'
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.getRecurringOrderPayment()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource
    delete:
      tags:
      - Payment
      summary: Removes payment from recurring order
      description: This operation removes the selected payment method from the recurring
        order payments.
      operationId: removePaymentFromRecurringOrder
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      responses:
        "204":
          description: No content - The payment was successfully deleted.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.removePaymentFromRecurringOrder()
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource
  /privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect:
    put:
      tags:
      - Payment
      summary: Get return-URLs from REST client for payment provider redirect
      description: "The REST client sends the return URLs to the system, so that the\
        \ redirect URL for the payment service provider can be created. This redirect\
        \ URL will be sent as response to the REST client so that the client can process\
        \ the redirect action. After that, the user will be redirected back to his\
        \ REST client based on the return URLs.\n\nNote: This operation requires authentication\
        \ with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).\n"
      operationId: createRecurringOrderPaymentRedirectURL
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRedirectRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRedirectRO'
      responses:
        "201":
          description: Created - The redirect URL was successfully created.
        "400":
          description: Bad request - The payment service does not support redirect
            capability.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
    post:
      tags:
      - Payment
      summary: Get transaction details after redirect before checkout
      description: "When the user has processed a payment transaction at the payment\
        \ provider's system, he will be redirected back to the REST client. Regardless\
        \ of the outcome of this transaction, the return redirect contains various\
        \ payment transaction attributes which must be transferred from the REST client\
        \ back to the shop system to process the payment transaction. The redirect\
        \ POST request transfers this data from the REST client into the shop system\
        \ so that the payment transaction can be activated there. For instance:\n\n\
        - Transaction ID\n\n- Transaction status\n\n- etc\n\nNote: This operation\
        \ requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE',\
        \ only in B2B applications).\n"
      operationId: addRecurringOrderPaymentRedirectResponseData
      parameters:
      - name: CustomerKey
        in: path
        description: The customer ID
        required: true
        schema:
          type: string
          description: The customer ID
          example: OilCorp
        example: OilCorp
        x-item-key: com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
      - name: RecurringOrderKey
        in: path
        description: The recurring order ID
        required: true
        schema:
          type: string
          description: The recurring order ID
          example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        example: 5Z.sEmZRpW0AAAF2Bi2CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource
      - name: RecurringOrderPaymentKey
        in: path
        description: The payment ID
        required: true
        schema:
          type: string
          description: The payment ID
          example: S2qsEmZRqqwAAAF27a.CwBhv
        example: S2qsEmZRqqwAAAF27a.CwBhv
        x-item-key: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRedirectResponseRO'
          text/xml:
            schema:
              $ref: '#/components/schemas/PaymentRedirectResponseRO'
      responses:
        "200":
          description: OK- The payment transaction was activated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentRO'
            text/xml:
              schema:
                $ref: '#/components/schemas/PaymentRO'
        "400":
          description: Bad request - The payment service does not support redirect
            capability.
        "401":
          description: Unauthorized - The user could not be authenticated.
        "403":
          description: Forbidden - The user does not have the required permissions.
        "404":
          description: "Not found - The customer, the recurring order or the payment\
            \ could not be found."
      security:
      - bearerAuth: []
      - basicAuth: []
      - authToken: []
      x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO
        com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)
      x-origin-class: com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource
components:
  schemas:
    LinkRO:
      title: Link
      type: object
      properties:
        name:
          type: string
          description: The name of the returned element
          xml:
            attribute: true
        type:
          type: string
          description: "This is a constant: **Link**"
          readOnly: true
          example: Link
          xml:
            attribute: true
        attributes:
          type: array
          description: The list of attributes
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/ResourceAttribute'
        uri:
          type: string
          description: The URI
        relation:
          type: string
          description: The relation of the link
          externalDocs:
            description: Link Relations (www.iana.org)
            url: http://www.iana.org/assignments/link-relations/link-relations.xml
          enum:
          - about
          - alternate
          - appendix
          - archives
          - author
          - bookmark
          - canonical
          - chapter
          - collection
          - contents
          - copyright
          - create-form
          - current
          - describedby
          - describes
          - disclosure
          - duplicate
          - edit
          - edit-form
          - edit-media
          - enclosure
          - first
          - glossary
          - help
          - hosts
          - hub
          - icon
          - index
          - item
          - last
          - latest-version
          - license
          - lrdd
          - monitor
          - monitor-group
          - next
          - next-archive
          - nofollow
          - noreferrer
          - payment
          - predecessor-version
          - prefetch
          - prev
          - preview
          - previous
          - prev-archive
          - privacy-policy
          - profile
          - related
          - replies
          - search
          - section
          - self
          - service
          - start
          - stylesheet
          - subsection
          - successor-version
          - tag
          - terms-of-service
          - type
          - up
          - version-history
          - via
          - working-copy
          - working-copy-of
        title:
          type: string
          description: The title of the link
        description:
          type: string
          description: The description of the link
        itemId:
          type: string
          description: The ID of the linked item
        attribute:
          $ref: '#/components/schemas/ResourceAttribute'
      description: A Link pointing to a resource
      xml:
        name: Link
    MoneyRO:
      title: Money
      type: object
      properties:
        type:
          type: string
          description: "This is a constant: **Money**"
          readOnly: true
          example: Money
          xml:
            attribute: true
        value:
          type: number
          description: The monetary value.
          example: 10.99
        currencyMnemonic:
          type: string
          deprecated: true
        currency:
          type: string
          description: Three-letter currency code (ISO 4217) of the monetary value.
          example: USD
      description: Money combines a currency and a money amount.
      readOnly: true
      xml:
        name: Money
    RecurringOrderBuyerRO:
      title: RecurringOrderBuyer
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderBuyer
          xml:
            attribute: true
        title:
          type: string
          description: The title of the buyer
          example: Mr.
        firstName:
          type: string
          description: The first name of the buyer
          example: Fritz
        lastName:
          type: string
          description: The last name of the buyer
          example: Birdo
        birthday:
          type: string
          description: The birthday of the buyer
          example: Mon Jan 10 00:00:00 CET 1916
        businessPartnerNo:
          type: string
          description: The business partner number of the buyer
          example: fbirdo
        department:
          type: string
          description: The department of the buyer
          example: Accounting
        login:
          type: string
          description: The login of the buyer
          example: fbirdo@test.intershop.de
      description: This resource holds details about the buyer as RecurringOrderBuyerRO.
      xml:
        name: RecurringOrderBuyer
    RecurringOrderLinkRO:
      title: RecurringOrderLink
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderLink
          xml:
            attribute: true
        creationDate:
          type: string
          description: The creation date of the recurring order
          format: date-time
        startDate:
          type: string
          description: The start date of the recurring order
          format: date-time
        endDate:
          type: string
          description: The end date of the recurring oder
          format: date-time
        lastOrderDate:
          type: string
          description: The last order date of the recurring order
          format: date-time
        nextOrderDate:
          type: string
          description: The next scheduled order date of this recurring order
          format: date-time
        totalNet:
          $ref: '#/components/schemas/MoneyRO'
        totalGross:
          $ref: '#/components/schemas/MoneyRO'
        number:
          type: string
          description: The number of the recurring order
          example: "0000009"
        interval:
          type: object
          properties:
            years:
              type: integer
              format: int32
            months:
              type: integer
              format: int32
            days:
              type: integer
              format: int32
            zero:
              type: boolean
            negative:
              type: boolean
            chronology:
              type: object
              properties:
                calendarType:
                  type: string
                id:
                  type: string
            units:
              type: array
              items:
                type: object
                properties:
                  dateBased:
                    type: boolean
                  timeBased:
                    type: boolean
                  durationEstimated:
                    type: boolean
                  duration:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      negative:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
          description: The period of the recurring order
          example: P3M
        repetitions:
          type: integer
          description: The number of repititions for the recurring order
          format: int32
          example: 0
        active:
          type: boolean
          description: Is the recurring order active?
          example: true
        expired:
          type: boolean
          description: Indicates whether the recurring order is expired
          example: false
        itemCount:
          type: integer
          description: The number of items in the recurring order
          format: int32
          example: 1
        priceType:
          type: string
          description: The price type of the recurring order
          example: net
        buyer:
          $ref: '#/components/schemas/RecurringOrderBuyerRO'
        link:
          $ref: '#/components/schemas/LinkRO'
      description: This resource holds basic information on the recurring order required
        for the list view.
      xml:
        name: RecurringOrderLink
    RecurringOrderLinkROResourceCollection:
      type: object
      properties:
        pageable:
          type: string
          description: The pageable ID
        total:
          type: integer
          description: The pageable amount total
          format: int32
        offset:
          type: integer
          description: The pageable offset
          format: int32
        amount:
          type: integer
          description: The pageable amount
          format: int32
        elements:
          type: array
          description: The list of elements
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/RecurringOrderLinkRO'
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderLinkResourceCollection
          xml:
            attribute: true
        sortKeys:
          uniqueItems: true
          type: array
          description: The keys to sort for
          xml:
            wrapped: true
          items:
            type: string
            description: The keys to sort for
            xml:
              name: sortKey
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
      xml:
        name: RecurringOrderLinkResourceCollection
    ResourceAttribute:
      title: Attribute
      type: object
      properties:
        name:
          type: string
          description: The attribute's name
          xml:
            attribute: true
        type:
          type: string
          description: "This is a constant: **ResourceAttribute**"
          example: ResourceAttribute
          xml:
            attribute: true
        value:
          type: object
          description: The attribute's value.
      description: An attribute
      xml:
        name: ResourceAttribute
    AddressRO:
      title: Address
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: Address
          xml:
            attribute: true
        urn:
          type: string
          description: the URN representation of this address
          example: urn:address:customer:1234567890:0987654321
        id:
          type: string
          description: The ID of the returned element
          example: vagKAB17gg4AAAFGSkFqQASI
        addressName:
          type: string
          description: The name of the address
          example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
        title:
          type: string
          description: "The (personal) title of the contact person, like 'Mr.' or\
            \ 'Ms.'"
          example: Mrs.
        aristocraticTitle:
          type: string
          description: "the aristocratic title of the contact person, like <i>Lord</i>\
            \ or <i>Lady</i>"
        jobTitle:
          type: string
          description: the job title of the contact person
          example: CEO
        honorific:
          type: string
          description: "the honorific title of the contact person that denotes the\
            \ honored person's occupation, like <i>Captain</i>, <i>Coach</i>, <i>Officer</i>,\
            \ <i>Reverend</i> or the academic title, like <i>PhD</i>"
        firstName:
          type: string
          description: The (first) given name of the contact person
          example: Patricia
        secondName:
          type: string
          description: the second given name of the contact person
          example: Luise
        lastName:
          type: string
          description: The last name of the contact person
          example: Miller
        secondLastName:
          type: string
          description: the second last name of the contact person
        companyName1:
          type: string
          description: the company name
          example: PMiller ltd.
        companyName2:
          type: string
          description: The second company name
        addressLine1:
          type: string
          description: the first address line
          example: Berliner Str. 20
        addressLine2:
          type: string
          description: the second address line
          example: 1st Floor
        addressLine3:
          type: string
          description: The third address line
          example: Second door on the right
        postBox:
          type: string
          description: the post-office box
          example: PO Box 42
        mainDivision:
          type: string
          description: "the main division of the country, e. g. a state or province"
          example: AL
        mainDivisionName:
          type: string
          description: The localized display name of the main division
          example: Alabama
        subDivision:
          type: string
          description: The sub division code of the country.
          example: GB-PKN
        subDivisionName:
          type: string
          description: The localized display name of the sub division
          example: Perth and Kinross
        postalCode:
          type: string
          description: The postal code
          example: "14482"
        email:
          type: string
          description: the e-mail address of the contact person
          example: pmiller@intershop.de
        phoneMobile:
          type: string
          description: The number of the contact person's cell phone
          example: +49364112677
        phoneHome:
          type: string
          description: The phone number of the house or apartment where the contact
            person lives
          example: "049364112677"
        phoneBusiness:
          type: string
          description: The phone number of the contact person's company
          example: "049364112699"
        phoneBusinessDirect:
          type: string
          description: the business phone number of the contact person that allows
            an outside caller to connect directly to the contact person without any
            help of an attendant or operator
          example: "049364112659"
        country:
          type: string
          description: The display name of the country in the current locale
          example: Germany
        countryCode:
          type: string
          description: The country code
          example: DE
        city:
          type: string
          description: The name of the city
          example: Potsdam
        fax:
          type: string
          description: the fax number
          example: "049364112643"
        usage:
          type: object
          properties:
            empty:
              type: boolean
          description: " Returns usage information for the address. Every bit in the\
            \ returned set marks a specific usage type, like ship-from or invoice-to\
            \ address. If a bit is set, the address may be used for the specific purpose\
            \ mapped to this bit. Further bits may be used for custom types. Default\
            \ usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to"
      description: This resource holds the details of an address.
      xml:
        name: Address
    AppliedRebateRO:
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: AppliedRebate
          xml:
            attribute: true
        rebateType:
          type: string
          description: the type of the applied rebate
          example: OrderValueOffDiscount
        description:
          type: string
          description: The description of the applied rebate
          example: "For orders over 200 USD, a 10 USD Order discount is guaranteed\
            \ for the Promo Code 'INTERSHOP'."
        code:
          type: string
          description: the code of the applied rebate
          example: INTERSHOP
        amount:
          $ref: '#/components/schemas/MoneyRO'
      xml:
        name: AppliedRebate
    AppliedTaxRO:
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: AppliedTax
          xml:
            attribute: true
        rate:
          type: number
          description: "the tax rate, 100 = 100%"
          example: 19
        amount:
          $ref: '#/components/schemas/MoneyRO'
      description: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      xml:
        name: AppliedTax
    GenericPropertyROObject:
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          readOnly: true
          xml:
            attribute: true
        key:
          type: string
        property:
          type: object
        displayName:
          type: string
      xml:
        name: Property
    PaymentRO:
      title: Payment
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: Payment
          xml:
            attribute: true
        attributes:
          type: array
          description: The list of attributes
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/ResourceAttribute'
        id:
          type: string
          description: The payment ID
          example: dhKsEmZRPyEAAAF2hyV6dB2n
        limitedTenderBalance:
          $ref: '#/components/schemas/MoneyRO'
        paymentTotalAmount:
          $ref: '#/components/schemas/MoneyRO'
        accountIdentifier:
          type: string
          description: The optional account identifier for this payment instrument
          readOnly: true
          example: DE12****7890
        parameters:
          type: array
          description: The parameters for this payment
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/GenericPropertyROObject'
        attribute:
          $ref: '#/components/schemas/ResourceAttribute'
      xml:
        name: Payment
    QuantityRO:
      title: Quantity
      type: object
      properties:
        type:
          type: string
          description: "This is a constant: **Quantity**"
          readOnly: true
          example: Quantity
          xml:
            attribute: true
        value:
          type: number
          description: The quantity's value
          example: 10.99
        unit:
          type: string
          description: The quantity's ISO unit code.
          example: PIEC
      description: Quantity combines a quantity value and the ISO unit code the value
        is defined in.
      xml:
        name: Quantity
    RecurringOrderLineItemRO:
      title: RecurringOrderLineItem
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderLineItem
          xml:
            attribute: true
        sku:
          type: string
          description: The SKU of the line item
          example: "6946439"
        quantity:
          $ref: '#/components/schemas/QuantityRO'
        shipToAddress:
          $ref: '#/components/schemas/AddressRO'
        shippingMethod:
          $ref: '#/components/schemas/ShippingMethodRO'
        totals:
          $ref: '#/components/schemas/RecurringOrderLineItemTotalsRO'
        salesTaxes:
          type: array
          description: The sales taxes as collection of AppliedTaxRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/AppliedTaxRO'
        shippingTaxes:
          type: array
          description: The shipping taxes as collection of AppliedTaxRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/AppliedTaxRO'
        itemSurcharges:
          type: array
          description: The item surcharges as collection of SurchargeRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/SurchargeRO'
        itemImportSurcharges:
          type: array
          description: The item import surcharges as collection of SurchargeRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/SurchargeRO'
        rebates:
          type: array
          description: The applied rebates as collection of AppliedRebateRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/AppliedRebateRO'
        shippingRebates:
          type: array
          description: The shipping rebates as collection of AppliedRebateRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/AppliedRebateRO'
        product:
          $ref: '#/components/schemas/LinkRO'
        warranty:
          $ref: '#/components/schemas/LinkRO'
        giftWrap:
          $ref: '#/components/schemas/LinkRO'
        giftMessage:
          $ref: '#/components/schemas/LinkRO'
        thumbnail:
          $ref: '#/components/schemas/LinkRO'
        priceNet:
          $ref: '#/components/schemas/MoneyRO'
        singleBasePriceNet:
          $ref: '#/components/schemas/MoneyRO'
        priceGross:
          $ref: '#/components/schemas/MoneyRO'
        singleBasePriceGross:
          $ref: '#/components/schemas/MoneyRO'
        priceType:
          type: string
          description: The price type of the line item
          example: net
        id:
          type: string
          description: The ID of the line item
          example: g.AKDgA.KyoAAAFXVeY5PPtu
        position:
          type: integer
          description: The position of the line item
          format: int32
          example: 1
        isHiddenGift:
          type: boolean
          description: Is the line item a hidden gift?
          example: false
        isFreeGift:
          type: boolean
          description: Is the line item a free gift?
          example: false
        inStock:
          type: boolean
          description: Is this item in stock?
          example: true
        senderName:
          type: string
          description: The optional sender's name
        senderEmail:
          type: string
          description: The optional sender's email
        recipientName:
          type: string
          description: The optional recipients name
        recipientEmail:
          type: string
          description: The optional recipients email
        greetingMessage:
          type: string
          description: An optional greeting message
        variationProduct:
          type: boolean
          description: Indicates whether the product is a variation product.
          example: false
        bundleProduct:
          type: boolean
          description: Is this item part of a bundle?
          example: false
        availability:
          type: boolean
          description: Is this item available?
          example: true
      description: This resource holds the line items of the bucket as collection
        of RecurringOrderLineItemRO
      xml:
        name: RecurringOrderLineItem
    RecurringOrderLineItemTotalsRO:
      title: RecurringOrderLineItemTotals
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderLineItemTotals
          xml:
            attribute: true
        totalNet:
          $ref: '#/components/schemas/MoneyRO'
        rebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        shippingTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        shippingRebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        giftingTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        totalGross:
          $ref: '#/components/schemas/MoneyRO'
        rebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        shippingTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        shippingRebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        giftingTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        priceType:
          type: string
          description: The price type
          example: net
        salesTaxTotal:
          $ref: '#/components/schemas/MoneyRO'
        shippingTaxTotal:
          $ref: '#/components/schemas/MoneyRO'
      description: This resource holds the totals of the recurring order as RecurringOrderLineItemTotalsRO.
      xml:
        name: RecurringOrderLineItemTotals
    RecurringOrderRO:
      title: RecurringOrder
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrder
          xml:
            attribute: true
        id:
          type: string
          description: The ID of the recurring order
          example: JFAKDgAj7jAAAAFiUhRgWKqi
        number:
          type: string
          description: The number of the recurring order
          example: "0000009"
        active:
          type: boolean
          description: Indicates whether the recurring order is active or not
          example: true
        expired:
          type: boolean
          description: Is the recurring order expired?
          example: false
        multipleShipmentsSupported:
          type: boolean
          description: Are multiple shipments supported?
          example: true
        interval:
          type: string
          description: The interval of the recurring order
          example: P7D
        repetitions:
          type: integer
          description: The repetitions of the recurring order
          format: int32
          example: 42
        creationDate:
          type: string
          description: The creation date of the recurring order
          format: date-time
        startDate:
          type: string
          description: The start date of the recurring order
          format: date-time
        endDate:
          type: string
          description: The end date of the recurring order
          format: date-time
        buyer:
          $ref: '#/components/schemas/RecurringOrderBuyerRO'
        lastOrderDate:
          type: string
          description: The last order date of this recurring order
          format: date-time
        nextOrderDate:
          type: string
          description: The next scheduled order date of this recurring order
          format: date-time
        modifiedDate:
          type: string
          description: The date of the last modification of the recurring order
          format: date-time
        itemCount:
          type: integer
          description: The item count of this recurring order
          format: int32
          example: 1
        orderCount:
          type: integer
          description: The count of orders from this recurring order
          format: int32
          example: 2
        errorCode:
          type: string
          description: The error code if an error occurred during execution of recurring
            order
        invoiceToAddress:
          $ref: '#/components/schemas/AddressRO'
        commonShipToAddress:
          $ref: '#/components/schemas/AddressRO'
        commonShippingMethod:
          $ref: '#/components/schemas/ShippingMethodRO'
        payments:
          type: array
          description: The payment methods for the recurring order as collection of
            PaymentROs
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/PaymentRO'
        shippingBuckets:
          type: array
          description: The shipping buckets of the recurring order as collection of
            RecurringOrderShippingBucketROs
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/RecurringOrderShippingBucketRO'
        totals:
          $ref: '#/components/schemas/RecurringOrderTotalsRO'
      description: This resource holds extended information on the recurring order.
      xml:
        name: RecurringOrder
    RecurringOrderShippingBucketRO:
      title: RecurringOrderShippingBucket
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderShippingBucket
          xml:
            attribute: true
        shipToAddress:
          $ref: '#/components/schemas/AddressRO'
        shippingMethod:
          $ref: '#/components/schemas/ShippingMethodRO'
        packSlipMessage:
          type: string
          description: The pack slip message of the bucket
          example: Your order is here.
        shippingInstructions:
          type: string
          description: The shipping instructions of the bucket
          example: Keep away from water!
        lineItems:
          type: array
          description: The line items of the bucket as collection of RecurringOrderLineItemRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/RecurringOrderLineItemRO'
      description: This resource holds the shipping buckets of the recurring order
        as collection of RecurringOrderShippingBucketROs.
      xml:
        name: RecurringOrderShippingBucket
    RecurringOrderTotalsRO:
      title: RecurringOrderTotals
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: RecurringOrderTotals
          xml:
            attribute: true
        itemTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        itemRebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        shippingTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        itemShippingRebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        bucketShippingRebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        rebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        shippingRebatesTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        paymentCostsTotalNet:
          $ref: '#/components/schemas/MoneyRO'
        totalNet:
          $ref: '#/components/schemas/MoneyRO'
        itemTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        itemRebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        shippingTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        itemShippingRebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        bucketShippingRebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        rebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        shippingRebatesTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        paymentCostsTotalGross:
          $ref: '#/components/schemas/MoneyRO'
        totalGross:
          $ref: '#/components/schemas/MoneyRO'
        taxTotal:
          $ref: '#/components/schemas/MoneyRO'
        dutiesAndSurchargesTotal:
          $ref: '#/components/schemas/MoneyRO'
        priceType:
          type: string
          description: The price type
          example: net
      description: This resource holds the recurring order's totals as RecurringOrderTotalsRO.
      xml:
        name: RecurringOrderTotals
    ShippingMethodRO:
      title: ShippingMethodRO
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: ShippingMethod
          xml:
            attribute: true
        id:
          type: string
          description: the id of the returned element
          example: STD_GROUND
        shippingTimeMin:
          type: integer
          description: The minimum shipping time in days
          format: int32
          example: 3
        shippingTimeMax:
          type: integer
          description: The maximum shipping time in days
          format: int32
          example: 7
      description: This resource describes a shipping method that can be selected
        as delivery option.
      xml:
        name: ShippingMethod
    SurchargeRO:
      title: SurchargeRO
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: Surcharge
          xml:
            attribute: true
        amount:
          $ref: '#/components/schemas/MoneyRO'
        description:
          type: string
          description: the description of the surcharge
        displayName:
          type: string
          description: the display name of the surcharge
        taxes:
          type: array
          description: the taxes applied to the surcharge amount as collection of
            AppliedTaxRO
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/AppliedTaxRO'
      description: This resource describes a single surcharge incurred to a shipping
        bucket.
      xml:
        name: Surcharge
    UpdateRecurringOrderRO:
      title: UpdateRecurringOrder
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          readOnly: true
          example: RecurringOrder
          xml:
            attribute: true
        active:
          type: boolean
          description: Determines whether the recurring order is active
          example: true
      description: This resource holds information for updating the status of a recurring
        order.
      xml:
        name: RecurringOrder
    PaymentOptionRO:
      title: PaymentOption
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: PaymentOption
          xml:
            attribute: true
        id:
          type: string
          description: The ID of the payment option
          example: ISH_INVOICE
        displayName:
          type: string
          description: The display name of the payment option
          example: Invoice
        applicability:
          type: string
          example: Applicable
        restrictions:
          type: array
          description: The restrictions for this payment option
          xml:
            wrapped: true
          items:
            type: string
            xml:
              name: restriction
        paymentParameters:
          type: array
          description: The parameters for this payment option
          xml:
            name: parameters
            wrapped: true
          items:
            $ref: '#/components/schemas/GenericPropertyROObject'
      description: This resource holds information on a payment option.
      xml:
        name: PaymentOption
    PaymentOptionsForMethodRO:
      title: PaymentOptionsForMethod
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: PaymentOptionsForMethodRO
          xml:
            attribute: true
        payments:
          type: array
          description: The payments
          items:
            $ref: '#/components/schemas/PaymentOptionRO'
        method:
          type: string
          description: The HTTP method to use when adding this method
          example: POST
      description: This resource holds information about payment methods that can
        be added and the HTTP method to be used.
      xml:
        name: PaymentOptionsForMethodRO
    PaymentOptionsRO:
      title: PaymentOptions
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          example: PaymentOptions
          xml:
            attribute: true
        methods:
          type: array
          description: The payment methods that can be added via HTTP
          items:
            $ref: '#/components/schemas/PaymentOptionsForMethodRO'
      description: This resource holds one or more PaymentOptionsForMethodRO.
      xml:
        name: PaymentOptions
    LinkROResourceCollectionRO:
      type: object
      properties:
        pageable:
          type: string
          description: The pageable ID
        total:
          type: integer
          description: The pageable amount total
          format: int32
        offset:
          type: integer
          description: The pageable offset
          format: int32
        amount:
          type: integer
          description: The pageable amount
          format: int32
        elements:
          type: array
          description: The list of elements
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/LinkRO'
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          xml:
            attribute: true
        sortKeys:
          uniqueItems: true
          type: array
          description: The keys to sort for
          xml:
            wrapped: true
          items:
            type: string
            description: The keys to sort for
            xml:
              name: sortKey
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
      description: This resource holds a list of Link-ResourceObjects.
      xml:
        name: ResourceCollection
    ResourceCollectionROLinkRO:
      title: Link List
      type: object
      properties:
        pageable:
          type: string
          description: The pageable ID.
        total:
          type: integer
          description: The pageable amount total
          format: int32
        offset:
          type: integer
          description: The pageable offset
          format: int32
        amount:
          type: integer
          description: The pageable amount
          format: int32
        elements:
          type: array
          description: The list of elements
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/LinkRO'
        type:
          type: string
          description: "This is a constant: **ResourceCollection**"
          example: ResourceCollection
          xml:
            attribute: true
        sortKeys:
          uniqueItems: true
          type: array
          description: The keys to sort for
          xml:
            wrapped: true
          items:
            type: string
            description: The keys to sort for
            xml:
              name: sortKey
        name:
          type: string
          description: The name of the returned element
          xml:
            attribute: true
      description: A list of links
      xml:
        name: ResourceCollection
    PaymentRedirectResponseRO:
      title: PaymentRedirectResponse
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          readOnly: true
          example: PaymentRedirectResponse
          xml:
            attribute: true
        attributes:
          type: array
          description: The list of attributes
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/ResourceAttribute'
        id:
          type: string
          example: The ID
        parameters:
          type: array
          description: The parameters for this redirect response
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/GenericPropertyROObject'
        attribute:
          $ref: '#/components/schemas/ResourceAttribute'
      xml:
        name: PaymentRedirectResponse
    PaymentRedirectRO:
      title: PaymentRedirect
      type: object
      properties:
        name:
          type: string
          description: The name of an element
          xml:
            attribute: true
        type:
          type: string
          description: 'The type of the element. This is normally a **constant** that
            can be used to differentiate elements by their type. '
          readOnly: true
          example: PaymentRedirect
          xml:
            attribute: true
        successURL:
          type: string
          description: The URL to return to when succeeded
        failURL:
          type: string
          description: The URL to return to when failed
        cancelURL:
          type: string
          description: The URL to return to when canceled
      xml:
        name: PaymentRedirect
  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
    "428":
      description: Precondition Required
    "429":
      description: Too Many Requests
    "431":
      description: Request Header Fields Too Large
    "500":
      description: Internal Server Error
    "501":
      description: Not Implemented
    "502":
      description: Bad Gateway
    "503":
      description: Service Unavailable
    "504":
      description: Gateway Timeout
    "505":
      description: HTTP Version Not Supported
    "511":
      description: Network Authentication Required
  parameters:
    loc:
      name: loc
      in: path
      description: "The locale ID (submitted as optional matrix parameter ```;loc=<LOCALE>```).\
        \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\
        \ user's default locale, site's default locale. The available locales depend\
        \ on your individual Intershop Commerce Management installation. Use IANA\
        \ language definitions for languages and regions and combine them using a\
        \ underscore, e. g. ```en_US```."
      required: false
      style: matrix
      schema:
        type: string
        description: "The locale ID (submitted as optional matrix parameter ```;loc=<LOCALE>```).\
          \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\
          \ user's default locale, site's default locale. The available locales depend\
          \ on your individual Intershop Commerce Management installation. Use IANA\
          \ language definitions for languages and regions and combine them using\
          \ a underscore, e. g. ```en_US```."
        default: en_US
      examples:
        en_US:
          description: English (United States)
          value: en_US
        fr_FR:
          description: French (France)
          value: fr_FR
        de_DE:
          description: German (Germany)
          value: de_DE
      x-matrixParamPath: /
    cur:
      name: cur
      in: path
      description: "The currency code (submitted as optional matrix parameter ```;cur=<CURRENCY>```).\
        \ If omitted, the site's or user's default currency is used."
      required: false
      style: matrix
      schema:
        type: string
        description: "The currency code (submitted as optional matrix parameter ```;cur=<CURRENCY>```).\
          \ If omitted, the site's or user's default currency is used."
        default: USD
      examples:
        FJD:
          description: Fiji Dollar
          value: FJD
        STD:
          description: São Tomé / Príncipe Dobra
          value: STD
        MXN:
          description: Mexican Peso
          value: MXN
        SCR:
          description: Seychelles Rupee
          value: SCR
        LVL:
          description: Latvian Lats
          value: LVL
        CDF:
          description: Congolese Franc
          value: CDF
        GTQ:
          description: Guatemalan Quetzal
          value: GTQ
        BBD:
          description: Barbados Dollar
          value: BBD
        CLP:
          description: Chilean Peso
          value: CLP
        UGX:
          description: Ugandan Shilling
          value: UGX
        HNL:
          description: Honduran Lempira
          value: HNL
        ZAR:
          description: South African Rand
          value: ZAR
        TND:
          description: Tunisian Dinar
          value: TND
        SLL:
          description: Sierra Leonean Leone
          value: SLL
        BSD:
          description: Bahamian Dollar
          value: BSD
        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
        PGK:
          description: Papua New Guinean Kina
          value: PGK
        OMR:
          description: Omani Rial
          value: OMR
        AZN:
          description: Azerbaijanian Manat
          value: AZN
        SEK:
          description: Swedish Krona
          value: SEK
        KES:
          description: Kenyan Shilling
          value: KES
        UAH:
          description: Ukrainian Hryvnia
          value: UAH
        BTN:
          description: Ngultrum
          value: BTN
        GNF:
          description: Guinea Franc
          value: GNF
        MZN:
          description: Mozambican Metical
          value: MZN
        ERN:
          description: Nakfa
          value: ERN
        SVC:
          description: Salvadoran Colón
          value: SVC
        ARS:
          description: Argentine Peso
          value: ARS
        QAR:
          description: Qatari Riyal
          value: QAR
        NLG:
          description: Dutch Guilder
          value: NLG
        IRR:
          description: Iranian Rial
          value: IRR
        MRO:
          description: Mauritanian Ouguiya
          value: MRO
        XPF:
          description: CFP Franc
          value: XPF
        UZS:
          description: Uzbekistani Som
          value: UZS
        THB:
          description: Thai Baht
          value: THB
        CNY:
          description: Yuan Renminbi
          value: CNY
        BDT:
          description: Bangladeshi Taka
          value: BDT
        LYD:
          description: Libyan Dinar
          value: LYD
        BMD:
          description: Bermudian Dollar
          value: BMD
        PHP:
          description: Philippine Peso
          value: PHP
        KWD:
          description: Kuwaiti Dinar
          value: KWD
        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
        USD:
          description: US Dollar
          value: USD
        MKD:
          description: Denar
          value: MKD
        DZD:
          description: Algerian Dinar
          value: DZD
        PAB:
          description: Panamanian Balboa
          value: PAB
        SGD:
          description: Singapore Dollar
          value: SGD
        ETB:
          description: Ethiopian Birr
          value: ETB
        VUV:
          description: Vanuatu Vatu
          value: VUV
        VEF:
          description: Venezuelan Bolivar Fuerte
          value: VEF
        SOS:
          description: Somali Shilling
          value: SOS
        KGS:
          description: Som
          value: KGS
        LAK:
          description: Lao Kip
          value: LAK
        ZMK:
          description: Zambian Kwacha
          value: ZMK
        BND:
          description: Brunei Dollar
          value: BND
        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
        TRY:
          description: Turkish Lira
          value: TRY
        SHP:
          description: Saint Helena Pound
          value: SHP
        BWP:
          description: Botswana Pula
          value: BWP
        LBP:
          description: Lebanese Pound
          value: LBP
        CYP:
          description: Cyprus Pound
          value: CYP
        TJS:
          description: Tajikistani Somoni
          value: TJS
        JOD:
          description: Jordanian Dinar
          value: JOD
        RWF:
          description: Rwanda Franc
          value: RWF
        HKD:
          description: Hong Kong Dollar
          value: HKD
        AED:
          description: United Arab Emirates Dirham
          value: AED
        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
        SYP:
          description: Syrian Pound
          value: SYP
        NOK:
          description: Norwegian Krone
          value: NOK
        MUR:
          description: Mauritian Rupee
          value: MUR
        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
        XCD:
          description: East Carribean Dollar
          value: XCD
        GRD:
          description: Greek Drachma
          value: GRD
        HTG:
          description: Haitian Gourde
          value: HTG
        ANG:
          description: Netherlands Antillian Guilder
          value: ANG
        SIT:
          description: Slovenian Tolar
          value: SIT
        BHD:
          description: Bahraini Dinar
          value: BHD
        PTE:
          description: Portuguese Escudo
          value: PTE
        BPP:
          description: Bonus Point Price
          value: BPP
        SZL:
          description: Swazi Lilangeni
          value: SZL
        SRD:
          description: Surinam Dollar
          value: SRD
        KZT:
          description: Kazakhstani Tenge
          value: KZT
        TTD:
          description: Trinidad and Tobago Dollar
          value: TTD
        SAR:
          description: Saudi Riyal
          value: SAR
        LTL:
          description: Lithuanian Litas
          value: LTL
        YER:
          description: Yemeni Rial
          value: YER
        MVR:
          description: Maldivian Rufiyaa
          value: MVR
        BPV:
          description: Bonus Point Value
          value: BPV
        AFN:
          description: Afghani
          value: AFN
        INR:
          description: Indian Rupee
          value: INR
        NPR:
          description: Nepalese Rupee
          value: NPR
        KRW:
          description: South Korean Won
          value: KRW
        AWG:
          description: Aruban Florin
          value: AWG
        MNT:
          description: Mongolian Tugrik
          value: MNT
        JPY:
          description: Japanese Yen
          value: JPY
        PLN:
          description: Polish Złoty
          value: PLN
        AOA:
          description: Angolan Kwanza
          value: AOA
        SBD:
          description: Solomon Islands Dollar
          value: SBD
        GBP:
          description: Pound Sterling
          value: GBP
        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 personalization group identifier, submitted as matrix parameter\
        \ ```;pgid=<PGID>```. Required if you want to work with customer-specific\
        \ content."
      required: false
      style: matrix
      schema:
        type: string
        description: "The personalization group identifier, submitted as matrix parameter\
          \ ```;pgid=<PGID>```. Required if you want to work with customer-specific\
          \ content."
        example: FUOGrzQ_VjORpGaN8DRGmLLE0000
      example: FUOGrzQ_VjORpGaN8DRGmLLE0000
    spgid:
      name: spgid
      in: path
      description: "The secure personalization group identifier, submitted as matrix\
        \ parameter ```;spgid=<PGID>```. Required if you want to work with customer-specific\
        \ content."
      required: false
      style: matrix
      schema:
        type: string
        description: "The secure personalization group identifier, submitted as matrix\
          \ parameter ```;spgid=<PGID>```. Required if you want to work with customer-specific\
          \ content."
        example: FUOGrzQ_VjORpGaN8DRGmLLE0000
      example: FUOGrzQ_VjORpGaN8DRGmLLE0000
  securitySchemes:
    basicAuth:
      type: http
      description: "Basic access authentication. In basic authentication, a request\
        \ contains a header field in the form of authorization: ```Basic <credentials>```,\
        \  where credentials is the Base64 encoding of ID and password joined by a\
        \ single colon :."
      scheme: basic
    authToken:
      type: apiKey
      description: User authentication token to authenticate the request. The token
        is a string generated by the ICM server in the same header in every response
        of an REST endpoint.
      name: authentication-token
      in: header
    bearerAuth:
      type: http
      description: "Bearer token authentication. A request contains a header field\
        \ in the form of authorization: ```Bearer <token>```, where <token> is a string\
        \ generated by an authentication service in response to a login request."
      scheme: bearer
      bearerFormat: JWT
x-apiID: recurring-order
x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource,com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource,com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource"