Virto Commerce

Virto Commerce Order Management API

Document based flexible order management system.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.virtocommerce.org/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/openapi/virto-commerce-order-management-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-catalog
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-pricing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-inventory
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-order
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-x-cart
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-customer
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-marketing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-quote
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-store
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-platform

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/graphql/virto-commerce-graphql.md

OpenAPI Specification

virto-commerce-order-management-api-openapi.yml Raw ↑ 
openapi: 3.0.4
info:
  title: VirtoCommerce.Cart Catalog Order Management API
  version: v1
  description: Easily manage your products, categories, variations, and properties
tags:
- name: Order Management
  description: Document based flexible order management system.
paths:
  /api/order/customerOrders/search:
    post:
      tags:
      - Order Management
      summary: Search customer orders by given criteria
      operationId: OrderModule_SearchCustomerOrder
      requestBody:
        description: criteria
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderSearchCriteria'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderSearchCriteria'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderSearchCriteria'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrderSearchResult'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrderSearchResult'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrderSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/number/{number}:
    get:
      tags:
      - Order Management
      summary: Find customer order by number
      description: Return a single customer order with all nested documents or null if order was not found
      operationId: OrderModule_GetByNumber
      parameters:
      - name: number
        in: path
        description: customer order number
        required: true
        schema:
          type: string
      - name: respGroup
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/{id}:
    get:
      tags:
      - Order Management
      summary: Find customer order by id
      description: Return a single customer order with all nested documents or null if order was not found
      operationId: OrderModule_GetById
      parameters:
      - name: id
        in: path
        description: customer order id
        required: true
        schema:
          type: string
      - name: respGroup
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
    patch:
      tags:
      - Order Management
      summary: Partial update for the specified Orde by id
      operationId: OrderModule_PatcOrder
      parameters:
      - name: id
        in: path
        description: Orde id
        required: true
        schema:
          type: string
      requestBody:
        description: JsonPatchDocument object with fields to update
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Operation'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Operation'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Operation'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/outer/{outerId}:
    get:
      tags:
      - Order Management
      summary: Find customer order by outer id
      description: Return a single customer order with all nested documents or null if order was not found
      operationId: OrderModule_GetByOuterId
      parameters:
      - name: outerId
        in: path
        description: customer order outer id
        required: true
        schema:
          type: string
      - name: responseGroup
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/recalculate:
    put:
      tags:
      - Order Management
      summary: Calculate order totals after changes
      description: Return order with recalculated totals
      operationId: OrderModule_CalculateTotals
      requestBody:
        description: Customer order
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/{orderId}/processPayment/{paymentId}:
    post:
      tags:
      - Order Management
      summary: Register customer order payment in external payment system
      description: Used in storefront checkout or manual order payment registration
      operationId: OrderModule_ProcessOrderPayments
      parameters:
      - name: orderId
        in: path
        description: customer order id
        required: true
        schema:
          type: string
      - name: paymentId
        in: path
        description: payment id
        required: true
        schema:
          type: string
      requestBody:
        description: banking card information
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BankCardInfo'
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BankCardInfo'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProcessPaymentRequestResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessPaymentRequestResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ProcessPaymentRequestResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/{cartId}:
    post:
      tags:
      - Order Management
      summary: Create new customer order based on shopping cart.
      operationId: OrderModule_CreateOrderFromCart
      parameters:
      - name: cartId
        in: path
        description: shopping cart id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:create
      - api_key:
        - order:create
      - api_key_header:
        - order:create
      - http-signature:
        - order:create
      - basic:
        - order:create
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders:
    post:
      tags:
      - Order Management
      summary: Add new customer order to system
      operationId: OrderModule_CreateOrder
      requestBody:
        description: customer order
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrder'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:create
      - api_key:
        - order:create
      - api_key_header:
        - order:create
      - http-signature:
        - order:create
      - basic:
        - order:create
      x-virtocommerce-module-id: VirtoCommerce.Orders
    put:
      tags:
      - Order Management
      summary: Update a existing customer order
      operationId: OrderModule_UpdateOrder
      requestBody:
        description: customer order
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrder'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
    delete:
      tags:
      - Order Management
      summary: Delete a whole customer orders
      operationId: OrderModule_DeleteOrdersByIds
      parameters:
      - name: ids
        in: query
        description: customer order ids for delete
        schema:
          type: array
          items:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/{id}/shipments/new:
    get:
      tags:
      - Order Management
      summary: Get new shipment for specified customer order
      description: Return new shipment document with populates all required properties.
      operationId: OrderModule_GetNewShipment
      parameters:
      - name: id
        in: path
        description: customer order id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/OrderShipment'
            application/json:
              schema:
                $ref: '#/components/schemas/OrderShipment'
            text/json:
              schema:
                $ref: '#/components/schemas/OrderShipment'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/{id}/payments/new:
    get:
      tags:
      - Order Management
      summary: Get new payment for specified customer order
      description: Return new payment  document with populates all required properties.
      operationId: OrderModule_GetNewPayment
      parameters:
      - name: id
        in: path
        description: customer order id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PaymentIn'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIn'
            text/json:
              schema:
                $ref: '#/components/schemas/PaymentIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/dashboardStatistics/settings:
    get:
      tags:
      - Order Management
      summary: Get dashboard statistics settings
      operationId: OrderModule_GetDashboardStatisticsSettingsAsync
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:dashboardstatistics:view
      - api_key:
        - order:dashboardstatistics:view
      - api_key_header:
        - order:dashboardstatistics:view
      - http-signature:
        - order:dashboardstatistics:view
      - basic:
        - order:dashboardstatistics:view
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/dashboardStatistics:
    get:
      tags:
      - Order Management
      summary: Get a some order statistic information for Commerce manager dashboard
      operationId: OrderModule_GetDashboardStatisticsAsync
      parameters:
      - name: start
        in: query
        description: start interval date
        schema:
          type: string
          format: date-time
      - name: end
        in: query
        description: end interval date
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DashboardStatisticsResult'
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardStatisticsResult'
            text/json:
              schema:
                $ref: '#/components/schemas/DashboardStatisticsResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:dashboardstatistics:view
      - api_key:
        - order:dashboardstatistics:view
      - api_key_header:
        - order:dashboardstatistics:view
      - http-signature:
        - order:dashboardstatistics:view
      - basic:
        - order:dashboardstatistics:view
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/paymentcallback:
    post:
      tags:
      - Order Management
      summary: Payment callback operation used by external payment services to inform post process payment in our system
      operationId: OrderModule_PostProcessPayment
      requestBody:
        description: payment callback parameters
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentCallbackParameters'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentCallbackParameters'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentCallbackParameters'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
            application/json:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
            text/json:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:payment:execute_callback
      - api_key:
        - order:payment:execute_callback
      - api_key_header:
        - order:payment:execute_callback
      - http-signature:
        - order:payment:execute_callback
      - basic:
        - order:payment:execute_callback
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/paymentcallback-raw:
    post:
      tags:
      - Order Management
      summary: Payment callback operation used by external payment services to inform post process payment in our system
      operationId: OrderModule_PostProcessPaymentRaw
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
            application/json:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
            text/json:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:payment:execute_callback
      - api_key:
        - order:payment:execute_callback
      - api_key_header:
        - order:payment:execute_callback
      - http-signature:
        - order:payment:execute_callback
      - basic:
        - order:payment:execute_callback
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/paymentcallback-form:
    post:
      tags:
      - Order Management
      summary: Payment callback operation used by external payment services to inform post process payment in our system
      operationId: OrderModule_PostProcessPaymentForm
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
            application/json:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
            text/json:
              schema:
                $ref: '#/components/schemas/PostProcessPaymentRequestResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - order:payment:execute_callback
      - api_key:
        - order:payment:execute_callback
      - api_key_header:
        - order:payment:execute_callback
      - http-signature:
        - order:payment:execute_callback
      - basic:
        - order:payment:execute_callback
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/invoice/{orderNumber}:
    get:
      tags:
      - Order Management
      operationId: OrderModule_GetInvoicePdf
      parameters:
      - name: orderNumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/{id}/changes:
    get:
      tags:
      - Order Management
      operationId: OrderModule_GetOrderChanges
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OperationLog'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OperationLog'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OperationLog'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/searchChanges:
    post:
      tags:
      - Order Management
      operationId: OrderModule_SearchOrderChanges
      requestBody:
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderHistorySearchCriteria'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderHistorySearchCriteria'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderHistorySearchCriteria'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ChangeLogSearchResult'
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeLogSearchResult'
            text/json:
              schema:
                $ref: '#/components/schemas/ChangeLogSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/indexed/searchEnabled:
    get:
      tags:
      - Order Management
      operationId: OrderModule_GetOrderFullTextSearchEnabled
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/customerOrders/indexed/search:
    post:
      tags:
      - Order Management
      operationId: OrderModule_SearchCustomerOrderIndexed
      requestBody:
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderIndexedSearchCriteria'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderIndexedSearchCriteria'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CustomerOrderIndexedSearchCriteria'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomerOrderSearchResult'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOrderSearchResult'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomerOrderSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/payments/search:
    post:
      tags:
      - Order Management
      summary: Search  order payments by given criteria
      operationId: OrderModulePayments_SearchOrderPayments
      requestBody:
        description: criteria
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentSearchCriteria'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentSearchCriteria'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentSearchCriteria'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PaymentSearchResult'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentSearchResult'
            text/json:
              schema:
                $ref: '#/components/schemas/PaymentSearchResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/payments/{id}:
    get:
      tags:
      - Order Management
      summary: Find  order payment by id
      description: Return a single order payment with all nested documents or null if payment was not found
      operationId: OrderModulePayments_GetById
      parameters:
      - name: id
        in: path
        description: order payment id
        required: true
        schema:
          type: string
      - name: respGroup
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PaymentIn'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIn'
            text/json:
              schema:
                $ref: '#/components/schemas/PaymentIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
    patch:
      tags:
      - Order Management
      summary: Partial update for the specified Payment by id
      operationId: OrderModulePayments_PatchPayment
      parameters:
      - name: id
        in: path
        description: Payment id
        required: true
        schema:
          type: string
      requestBody:
        description: JsonPatchDocument object with fields to update
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Operation'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Operation'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Operation'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/payments/outer/{outerId}:
    get:
      tags:
      - Order Management
      summary: Get order payment by outer id
      description: Return a single order payment with all nested documents or null if payment was not found
      operationId: OrderModulePayments_GetByOuterId
      parameters:
      - name: outerId
        in: path
        description: order payment outer id
        required: true
        schema:
          type: string
      - name: responseGroup
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PaymentIn'
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIn'
            text/json:
              schema:
                $ref: '#/components/schemas/PaymentIn'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      - api_key: []
      - api_key_header: []
      - http-signature: []
      - basic: []
      x-virtocommerce-module-id: VirtoCommerce.Orders
  /api/order/payments:
    post:
      tags:
      - Order Management
      summary: Create or update order payment
      operationId: OrderModulePayments_CreatePayment
      requestBody:
        description: payment
        content:
          application/json-patch+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentIn'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentIn'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PaymentIn'
   

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/openapi/virto-commerce-order-management-api-openapi.yml