Mews Order items API

The Order items API from Mews — 2 operation(s) for order items.

OpenAPI Specification

mews-systems-order-items-api-openapi.yml Raw ↑
openapi: 3.0.4
info:
  title: Mews Booking Engine API (Distributor) Account notes Order items API
  version: v1
  description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption.
  x-generated-from: documentation
  x-source-url: https://api.mews.com/Swagger/distributor/swagger.json
  x-last-validated: '2026-06-02'
servers:
- url: https://api.mews.com
  description: Production
- url: https://api.mews-demo.com
  description: Demo / sandbox
security:
- MewsClientToken: []
  MewsAccessToken: []
tags:
- name: Order items
paths:
  /api/connector/v1/orderItems/cancel:
    post:
      tags:
      - Order items
      summary: Mews Cancel Order Items
      description: Cancels all order items with specified identifiers. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: orderItems_cancel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderItemParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              OrderItemIds:
              - f5c6b7a8-9d4f-4e2a-8a3b-2f3b8b9e6a1f
              - a6b7c8d9-0e1f-4d2a-9b3c-5d6e7f8a9b0c
              EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
              examples:
                OrderItemsCancel200Example:
                  summary: Default orderItems_cancel 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel400Example:
                  summary: Default orderItems_cancel 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel401Example:
                  summary: Default orderItems_cancel 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel403Example:
                  summary: Default orderItems_cancel 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel408Example:
                  summary: Default orderItems_cancel 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel204Example:
                  summary: Default orderItems_cancel 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel429Example:
                  summary: Default orderItems_cancel 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsCancel500Example:
                  summary: Default orderItems_cancel 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-restricted: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/connector/v1/orderItems/getAll:
    post:
      tags:
      - Order items
      summary: Mews Get All Order Items
      description: Returns all order items. At least one of the `OrderItemIds`, `ServiceOrderIds`, `ServiceIds`, `BillIds`, `CreatedUtc`, `UpdatedUtc`, `ClosedUtc` filters must be specified in the request. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
      operationId: orderItems_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderItemFilterParameters'
            example:
              ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
              AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
              Client: Sample Client 1.0.0
              AccountIds:
              - fadd5bb6-b428-45d5-94f8-fd0d89fece6d
              - bccdafd1-3e44-439d-861f-341526b597a9
              CreatedUtc:
                StartUtc: '2023-01-01T00:00:00Z'
                EndUtc: '2023-01-31T23:59:59Z'
              EnterpriseIds:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              - 4d0201db-36f5-428b-8d11-4f0a65e960cc
              Limitation:
                Count: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderItemResult'
              example:
                OrderItems:
                - Id: 53896156-f25b-4949-b55b-afd3007b1146
                  EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  AccountId: c173bb22-6ff8-4ffd-875f-afb900c92865
                  AccountType: Customer
                  Notes: Additional note
                  ServiceId: 294c7859-63ba-46ad-a8bf-34fad2019383
                  ServiceOrderId: ac5ef5eb-c5b2-4083-879f-83f04a5ebda5
                  BillId: d27ffe99-ff92-4afb-ac03-9268f24f0556
                  AccountingCategoryId: c0610937-0165-4091-a79c-44eb34173daf
                  UnitCount: 1
                  UnitAmount:
                    Currency: EUR
                    NetValue: 5
                    GrossValue: 5
                    TaxValues:
                    - Code: DE-2020-1-Z
                      Value: 0
                    Breakdown:
                      Items:
                      - TaxRateCode: DE-2020-1-Z
                        NetValue: 5
                        TaxValue: 0
                  Amount:
                    Currency: EUR
                    NetValue: 5
                    GrossValue: 5
                    TaxValues:
                    - Code: DE-2020-1-Z
                      Value: 0
                    Breakdown:
                      Items:
                      - TaxRateCode: DE-2020-1-Z
                        NetValue: 5
                        TaxValue: 0
                  OriginalAmount:
                    Currency: EUR
                    NetValue: 5
                    GrossValue: 5
                    TaxValues:
                    - Code: DE-2020-1-Z
                      Value: 0
                    Breakdown:
                      Items:
                      - TaxRateCode: DE-2020-1-Z
                        NetValue: 5
                        TaxValue: 0
                  RevenueType: Additional
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  CreatedUtc: '2023-03-28T07:28:04Z'
                  UpdatedUtc: '2023-03-28T07:28:04Z'
                  ConsumedUtc: '2023-03-31T00:00:00Z'
                  CanceledUtc: null
                  ClosedUtc: null
                  StartUtc: '2023-03-30T22:00:00Z'
                  AccountingState: Open
                  Type: CityTax
                  Options:
                    CanceledWithReservation: false
                  Data: null
                - Id: bd11dc4a-8f9e-442b-bb1e-f5361b31dfa2
                  EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc
                  AccountId: c173bb22-6ff8-4ffd-875f-afb900c92865
                  AccountType: Company
                  Notes: Additional note
                  ServiceId: 05089c0c-5d55-4756-827b-c4bcee1edf00
                  ServiceOrderId: dd01a673-ee6e-4f10-9c93-afcd00759ddd
                  BillId: 297de6f8-bd67-4ebd-98b6-ecc1cd8f920c
                  AccountingCategoryId: c5819fe7-d67c-4c24-b02e-6ce84a1d3b1d
                  UnitCount: 1
                  UnitAmount:
                    Currency: EUR
                    NetValue: 93.46
                    GrossValue: 100
                    TaxValues:
                    - Code: DE-2020-1-L
                      Value: 6.54
                    Breakdown:
                      Items:
                      - TaxRateCode: DE-2020-1-L
                        NetValue: 93.46
                        TaxValue: 6.54
                  Amount:
                    Currency: EUR
                    NetValue: 93.46
                    GrossValue: 100
                    TaxValues:
                    - Code: DE-2020-1-L
                      Value: 6.54
                    Breakdown:
                      Items:
                      - TaxRateCode: DE-2020-1-L
                        NetValue: 93.46
                        TaxValue: 6.54
                  OriginalAmount:
                    Currency: EUR
                    NetValue: 93.46
                    GrossValue: 100
                    TaxValues:
                    - Code: DE-2020-1-L
                      Value: 6.54
                    Breakdown:
                      Items:
                      - TaxRateCode: DE-2020-1-L
                        NetValue: 93.46
                        TaxValue: 6.54
                  RevenueType: Service
                  CreatorProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  UpdaterProfileId: 3cd637ef-4728-47f9-8fb1-afb900c9cdcf
                  CreatedUtc: '2023-03-28T07:28:01Z'
                  UpdatedUtc: '2023-03-28T07:28:04Z'
                  ConsumedUtc: '2023-03-31T00:00:00Z'
                  CanceledUtc: null
                  ClosedUtc: null
                  StartUtc: '2023-03-30T22:00:00Z'
                  AccountingState: Open
                  Type: SpaceOrder
                  Options:
                    CanceledWithReservation: false
                  Data:
                    Discriminator: Product
                    Rebate: null
                    Product:
                      ProductId: 8c8dbd02-f2e2-4845-b964-afb900c8f919
                      AgeCategoryId: null
                Cursor: d98c9611-0006-4691-a835-af2e00b170c4
        '400':
          description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll400Example:
                  summary: Default orderItems_getAll 400 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll401Example:
                  summary: Default orderItems_getAll 401 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '403':
          description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll403Example:
                  summary: Default orderItems_getAll 403 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '408':
          description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll408Example:
                  summary: Default orderItems_getAll 408 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll204Example:
                  summary: Default orderItems_getAll 204 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '429':
          description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll429Example:
                  summary: Default orderItems_getAll 429 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
        '500':
          description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
              examples:
                OrderItemsGetAll500Example:
                  summary: Default orderItems_getAll 500 response
                  x-microcks-default: true
                  value:
                    Message: string
                    RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
                    Details: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    OrderItemResult:
      title: OrderItemResult
      required:
      - OrderItems
      type: object
      properties:
        OrderItems:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
          description: Set of requested order items.
        Cursor:
          type: string
          description: Unique identifier of the last and hence oldest order item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older order items.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
      additionalProperties: false
      x-schema-id: OrderItemResult
    OrderItemData:
      title: Order item data
      type: object
      properties:
        Discriminator:
          title: Order item data discriminator
          allOf:
          - $ref: '#/components/schemas/OrderItemDataDiscriminatorEnum'
          description: 'Discriminator pointing to the fields within this object that contains additional data.


            Rebate (Rebate.)


            Product (Product.)


            AllowanceDiscount (Allowance discount.)


            AllowanceProfits (Allowance profits.)'
          x-enumNames:
          - Rebate
          - Product
          - AllowanceDiscount
          - AllowanceProfits
          x-enumDescriptions:
          - Rebate.
          - Product.
          - Allowance discount.
          - Allowance profits.
          example: string
        Rebate:
          title: Rebate data
          allOf:
          - $ref: '#/components/schemas/OrderItemRebateData'
          description: Contains additional data in the case of rebate item.
          nullable: true
          example: string
        Product:
          title: Product data
          allOf:
          - $ref: '#/components/schemas/OrderItemProductData'
          description: Contains additional data in the case of product item.
          nullable: true
          example: string
        AllowanceDiscount:
          title: Allowance discount data
          allOf:
          - $ref: '#/components/schemas/OrderItemAllowanceDiscountData'
          description: Contains additional data in the case of allowance discount item.
          nullable: true
          example: string
        AllowanceProfits:
          title: Allowance profits data
          allOf:
          - $ref: '#/components/schemas/OrderItemAllowanceProfitsData'
          description: Contains additional data in the case of allowance profits item.
          nullable: true
          example: string
      additionalProperties: false
      description: Additional order item data.
      x-schema-id: OrderItemData
    CancelOrderItemParameters:
      title: CancelOrderItemParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - OrderItemIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
          example: string
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
          example: string
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
          example: string
        EnterpriseId:
          type: string
          description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        OrderItemIds:
          maxItems: 10
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the `OrderItems` to cancel.
      additionalProperties: false
      x-schema-id: CancelOrderItemParameters
    Unit:
      type: object
      additionalProperties: false
    OrderItemTypeEnum:
      title: Order item type
      enum:
      - CancellationFee
      - NightRebate
      - ProductOrderRebate
      - AdditionalExpenseRebate
      - Deposit
      - ExchangeRateDifference
      - CustomItem
      - ServiceCharge
      - CityTax
      - CityTaxDiscount
      - SpaceOrder
      - ProductOrder
      - Surcharge
      - TaxCorrection
      - ResourceUpgradeFee
      - InvoiceFee
      - MulticurrencyFee
      - AllowanceDiscount
      - AllowanceBreakage
      - AllowanceContraBreakage
      type: string
      description: '


        CancellationFee


        NightRebate


        ProductOrderRebate


        AdditionalExpenseRebate


        Deposit


        ExchangeRateDifference


        CustomItem


        ServiceCharge


        CityTax


        CityTaxDiscount


        SpaceOrder


        ProductOrder


        Surcharge


        TaxCorrection


        ResourceUpgradeFee


        InvoiceFee


        MulticurrencyFee


        AllowanceDiscount


        AllowanceBreakage


        AllowanceContraBreakage'
      x-enumNames:
      - CancellationFee
      - NightRebate
      - ProductOrderRebate
      - AdditionalExpenseRebate
      - Deposit
      - ExchangeRateDifference
      - CustomItem
      - ServiceCharge
      - CityTax
      - CityTaxDiscount
      - SpaceOrder
      - ProductOrder
      - Surcharge
      - TaxCorrection
      - ResourceUpgradeFee
      - InvoiceFee
      - MulticurrencyFee
      - AllowanceDiscount
      - AllowanceBreakage
      - AllowanceContraBreakage
      x-enumDescriptions:
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
      - ''
    OrderItemProductData:
      title: Product data
      required:
      - ProductId
      type: object
      properties:
        ProductId:
          type: string
          description: Unique identifier of the [Product](https://mews-systems.gitbook.io/connector-api/operations/products/#product).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AgeCategoryId:
          type: string
          description: Unique identifier of the [Age Category](https://mews-systems.gitbook.io/connector-api/operations/agecategories/#age-category).
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ProductType:
          allOf:
          - $ref: '#/components/schemas/ProductTypeEnum'
          description: 'Type of Product, e.g. whether allowance or product.


            Product


            Allowance'
          nullable: true
          example: string
      additionalProperties: false
      x-schema-id: OrderItemProductData
    OrderItemOptions:
      title: Order item options
      required:
      - CanceledWithReservation
      type: object
      properties:
        CanceledWithReservation:
          type: boolean
          description: Order item was canceled with reservation cancellation.
          example: true
      additionalProperties: false
      description: Options of the order item.
      x-schema-id: OrderItemOptions
    OrderItem:
      title: Order item
      required:
      - AccountingState
      - Amount
      - ConsumedUtc
      - CreatedUtc
      - CreatorProfileId
      - EnterpriseId
      - Id
      - Options
      - OriginalAmount
      - RevenueType
      - ServiceId
      - ServiceOrderId
      - Type
      - UnitAmount
      - UnitCount
      - UpdatedUtc
      - UpdaterProfileId
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the order item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        EnterpriseId:
          type: string
          description: Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise).
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountId:
          type: string
          description: Unique identifier of the account (for example [Customer](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer)) the order item belongs to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountType:
          allOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          description: 'A discriminator specifying the [type of account](https://mews-systems.gitbook.io/connector-api/operations/accounts/#account-type), e.g. customer or company.


            Company


            Customer'
          nullable: true
          example: string
        ServiceId:
          type: string
          description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) the order item is assigned to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        ServiceOrderId:
          type: string
          description: Unique identifier of the [Service order](https://mews-systems.gitbook.io/connector-api/operations/serviceorders/#service-order) the order item is assigned to.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        Notes:
          type: string
          description: Additional notes.
          nullable: true
          example: string
        BillId:
          type: string
          description: Unique identifier of the [Bill](https://mews-systems.gitbook.io/connector-api/operations/bills/#bill) the order item is assigned to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        AccountingCategoryId:
          type: string
          description: Unique identifier of the [Accounting category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category) the order item belongs to.
          format: uuid
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        BillingName:
          type: string
          description: Name of the order item for billing purposes.
          nullable: true
          example: Example Name
        ExternalIdentifier:
          type: string
          description: Identifier of the entity from external system.
          nullable: true
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        UnitCount:
          type: integer
          description: Unit count of item, i.e. the number of sub-items or units, if applicable.
          format: int32
          example: 1
        UnitAmount:
          title: Amount
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: Unit amount of item, i.e. the amount of each individual sub-item or unit, if applicable.
          example: string
        Amount:
          title: Amount
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: Amount of item; note a negative amount represents a rebate or payment.
          example: string
        OriginalAmount:
          title: Amount
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: Order item's original amount. Negative amount represents either rebate or a payment. Contains the earliest known value in conversion chain.
          example: string
        RevenueType:
          title: Revenue type
          allOf:
          - $ref: '#/components/schemas/RevenueTypeEnum'
          description: 'Revenue type of the item.


            Service


            Product


            Additional'
          x-enumNames:
          - Service
          - Product
          - Additional
          x-enumDescriptions:
          - ''
          - ''
          - ''
          example: string
        CreatorProfileId:
          type: string
          description: Unique identifier of the user who created the order item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        UpdaterProfileId:
          type: string
          description: Unique identifier of the user who updated the order item.
          format: uuid
          example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111
        CreatedUtc:
          minLength: 1
          type: string
          description: Creation date and time of the order item created in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        UpdatedUtc:
          minLength: 1
          type: string
          description: Last update date and time of the order item in UTC timezone in ISO 8601 format.
          format: date-time
          example: '2026-06-02T14:30:00Z'
        ConsumedUtc:
          minLength: 1
          type: string
          description: Date and time of the item consumption in UTC timezone in ISO 8601 format

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews-systems/refs/heads/main/openapi/mews-systems-order-items-api-openapi.yml