GSMA Open Gateway API Product Order API

openapi: 3.2.0
info:
  title: Open Gateway Operate API Onboarding and Ordering API Product Order API
  description: "**TMF931 - API Ordering, Developer & Application Onboarding and Management**   \n\nThis Operate API specification covers the onboarding operations between Channel Partners and Operators as described by GSMA. It offers a consolidation of multiple TM Forum based APIs into a single specification (a component suite). This API specification proposes : \n- Application Owner (Developer) Management (acceptance, onboarding, lifecycle management)  \n- Application Management (acceptance, onboarding, lifecycle management)  \n- Service API Management (ordering, retrieving)\n\nThis API is a composite DCS (Domain Context Specialization) of the following TMF Open APIs for Open Gateway context\n- TMF622 Product Ordering Management v5.0\n- TMF637 Product Inventory Management v5.0\n- TMF669 Party Role Management v5.0\n- TMF639 Resource Inventory v5.0\n\nCopyright © TM Forum 2025. All Rights Reserved\n"
  version: 5.2.1
  x-generation-tooling-version: v8.5.15
  x-generation-data-model-version: unknown
  x-generation-date: '2025-12-11T09:49:01.463Z'
  x-api-id: TMF931
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/'
  variables:
    apiRoot:
      default: https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5
      enum:
      - https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5
tags:
- name: apiProductOrder
  description: Operations for ApiProductOrder Resource
paths:
  /apiProductOrder:
    get:
      tags:
      - apiProductOrder
      summary: List or find ApiProductOrder objects
      description: List or find ApiProductOrder objects
      operationId: listApiProductOrder
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Before'
      - $ref: '#/components/parameters/After'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          $ref: '#/components/responses/200ApiProductOrderArray'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    post:
      tags:
      - apiProductOrder
      summary: Creates a ApiProductOrder
      description: This operation creates a ApiProductOrder entity.
      operationId: createApiProductOrder
      parameters:
      - $ref: '#/components/parameters/Fields'
      requestBody:
        $ref: '#/components/requestBodies/ApiProductOrder_FVO'
      responses:
        '201':
          $ref: '#/components/responses/201ApiProductOrder'
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
  /apiProductOrder/{id}:
    get:
      tags:
      - apiProductOrder
      summary: Retrieves a ApiProductOrder by ID
      description: This operation retrieves a ApiProductOrder entity. Attribute selection enabled for all first level attributes.
      operationId: retrieveApiProductOrder
      parameters:
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          $ref: '#/components/responses/200ApiProductOrder_Get'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
components:
  schemas:
    ApiProductOrder_FVO:
      allOf:
      - $ref: '#/components/schemas/Entity'
      - type: object
        description: An ApiProductOrder is a specialization of a ProductOrder, which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa.
        properties:
          description:
            type: string
            description: Description of the product order
          externalId:
            type: array
            items:
              $ref: '#/components/schemas/ExternalIdentifier_FVO'
            description: Can be used to pass the internal identifier of the order in the Channel Partner system.
          productOrderItem:
            type: array
            items:
              $ref: '#/components/schemas/DCSProductOrderItem_FVO'
            minItems: 1
            description: An identified part of the order. A product order is decomposed into one or more order items.
          agreement:
            type: array
            description: A reference to an agreement defined in the context of the product order
            items:
              $ref: '#/components/schemas/AgreementRef'
        required:
        - productOrderItem
      discriminator:
        propertyName: '@type'
        mapping:
          ApiProductOrder: '#/components/schemas/ApiProductOrder_FVO'
    EntityRef:
      allOf:
      - $ref: '#/components/schemas/Extensible'
      - $ref: '#/components/schemas/Addressable'
      - type: object
        description: Entity reference schema to be use for all entityRef class.
        properties:
          id:
            type: string
            description: The identifier of the referred entity.
          href:
            type: string
            description: The URI of the referred entity.
          name:
            type: string
            description: Name of the referred entity.
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
        required:
        - id
    Extensible:
      type: object
      description: Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type
      properties:
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class Extensible name
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
      required:
      - '@type'
    GCProductOrderItem:
      type: object
      description: General Context ProductOrderItem that can be used as a Domain Specialization Order Item or as a non-specialised OrderItem.
      allOf:
      - $ref: '#/components/schemas/Extensible'
      discriminator:
        propertyName: '@type'
        mapping:
          DCSProductOrderItem: '#/components/schemas/DCSProductOrderItem'
          GCProductOrderItem: '#/components/schemas/GCProductOrderItem'
    Entity:
      type: object
      description: Base entity schema for use in TMForum Open-APIs. Property.
      allOf:
      - $ref: '#/components/schemas/Extensible'
      - $ref: '#/components/schemas/Addressable'
    ExternalIdentifier:
      allOf:
      - $ref: '#/components/schemas/Extensible'
      - type: object
        description: An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.
        properties:
          owner:
            type: string
            description: Name of the external system that owns the entity.
            example: MagentoCommerce
          externalIdentifierType:
            type: string
            description: Type of the identification, typically would be the type of the entity within the external system
            example: ProductOrder
          id:
            type: string
            description: identification of the entity within the external system.
      discriminator:
        propertyName: '@type'
        mapping:
          ExternalIdentifier: '#/components/schemas/ExternalIdentifier'
    ExternalIdentifier_FVO:
      allOf:
      - $ref: '#/components/schemas/Extensible'
      - type: object
        description: An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.
        properties:
          owner:
            type: string
            description: Name of the external system that owns the entity.
            example: MagentoCommerce
          externalIdentifierType:
            type: string
            description: Type of the identification, typically would be the type of the entity within the external system
            example: ProductOrder
          id:
            type: string
            description: identification of the entity within the external system.
        required:
        - id
      discriminator:
        propertyName: '@type'
        mapping:
          ExternalIdentifier: '#/components/schemas/ExternalIdentifier_FVO'
    Error:
      discriminator:
        propertyName: '@type'
        mapping:
          Error: '#/components/schemas/Error'
      allOf:
      - $ref: '#/components/schemas/Extensible'
      - type: object
        required:
        - code
        - reason
        properties:
          code:
            type: string
            description: Application relevant detail, defined in the API or a common list.
          reason:
            type: string
            description: Explanation of the reason for the error which can be shown to a client user.
          message:
            type: string
            description: More details and corrective actions related to the error which can be shown to a client user.
          status:
            type: string
            description: HTTP Error code extension
          referenceError:
            type: string
            description: URI of documentation describing the error.
      description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
    AgreementRef:
      type: object
      description: Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.
      allOf:
      - $ref: '#/components/schemas/EntityRef'
      discriminator:
        propertyName: '@type'
        mapping:
          AgreementRef: '#/components/schemas/AgreementRef'
    DCSProductOrderItem:
      type: object
      description: An identified part of the order. A product order is decomposed into one or more order items.
      allOf:
      - $ref: '#/components/schemas/GCProductOrderItem'
      discriminator:
        propertyName: '@type'
        mapping:
          ApiProductOrderItemAdd: '#/components/schemas/ApiProductOrderItemAdd'
          ApiProductOrderItemModify: '#/components/schemas/ApiProductOrderItemModify'
          ProductOrderItemDelete: '#/components/schemas/ProductOrderItemDelete'
    Addressable:
      type: object
      description: Base schema for addressable entities
      properties:
        href:
          type: string
          description: Hyperlink reference
        id:
          type: string
          description: unique identifier
    PartyRoleRef:
      allOf:
      - $ref: '#/components/schemas/EntityRef'
      - type: object
        description: Party role reference. A party role represents the part played by a party in a given context.
        properties:
          partyId:
            type: string
            description: The identifier of the engaged party that is linked to the PartyRole object.
          partyName:
            type: string
            description: The name of the engaged party that is linked to the PartyRole object.
      discriminator:
        propertyName: '@type'
        mapping:
          PartyRoleRef: '#/components/schemas/PartyRoleRef'
    ApiProductOrder_RES:
      type: object
      description: Response object for ApiProductOrder
      allOf:
      - $ref: '#/components/schemas/ApiProductOrder'
      required:
      - id
      - href
      discriminator:
        propertyName: '@type'
        mapping:
          ApiProductOrder: '#/components/schemas/ApiProductOrder'
    DCSProductOrderItem_FVO:
      type: object
      description: An identified part of the order. A product order is decomposed into one or more order items.
      allOf:
      - $ref: '#/components/schemas/GCProductOrderItem'
      discriminator:
        propertyName: '@type'
        mapping:
          ApiProductOrderItemAdd: '#/components/schemas/ApiProductOrderItemAdd_FVO'
          ApiProductOrderItemModify: '#/components/schemas/ApiProductOrderItemModify_FVO'
          ProductOrderItemDelete: '#/components/schemas/ProductOrderItemDelete_FVO'
    ApiProductOrder:
      allOf:
      - $ref: '#/components/schemas/Entity'
      - type: object
        description: An ApiProductOrder is a specialization of a ProductOrder, which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa.
        properties:
          description:
            type: string
            description: Description of the product order
          externalId:
            type: array
            items:
              $ref: '#/components/schemas/ExternalIdentifier'
            description: Can be used to pass the internal identifier of the order in the Channel Partner system.
          productOrderItem:
            type: array
            items:
              $ref: '#/components/schemas/DCSProductOrderItem'
            minItems: 1
            description: An identified part of the order. A product order is decomposed into one or more order items.
          agreement:
            type: array
            description: A reference to an agreement defined in the context of the product order
            items:
              $ref: '#/components/schemas/AgreementRef'
          channelPartner:
            $ref: '#/components/schemas/PartyRoleRef'
          state:
            $ref: '#/components/schemas/ProductOrderStateType'
          stateReason:
            type: string
            description: A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection.
          creationDate:
            type: string
            format: date-time
            description: Date and time when the ProductOrder was created
          expectedCompletionDate:
            type: string
            format: date-time
            description: Expected delivery date amended by the provider
          completionDate:
            type: string
            format: date-time
            description: Date when the ProductOrder was completed
      discriminator:
        propertyName: '@type'
        mapping:
          ApiProductOrder: '#/components/schemas/ApiProductOrder'
    ProductOrderStateType:
      enum:
      - acknowledged
      - rejected
      - pending
      - held
      - inProgress
      - cancelled
      - completed
      - failed
      - partial
      - assessingCancellation
      - pendingCancellation
      - draft
      - inProgress.accepted
      type: string
      description: Possible values for the state of the order
  headers:
    X-Total-Count:
      description: Total number of items matching criteria
      schema:
        type: integer
    X-Result-Count:
      description: Actual number of items returned in the response body
      schema:
        type: integer
  responses:
    '501':
      description: Not Implemented
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Not Implemented Error
              value:
                '@type': Error
                code: ERR501
                reason: The requested operation is not implemented
                message: The requested operation is not implemented. Please contact the system administrator.
                referenceError: https://host/errors
    200ApiProductOrder_Get:
      description: Success
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiProductOrder_RES'
          examples:
            Retrieve_an_API_Product_Order_with_add_action_from_its_identifier:
              $ref: '#/components/examples/Retrieve_an_API_Product_Order_with_add_action_from_its_identifier_response'
            Retrieve_an_API_Product_Order_with_delete_action_from_its_identifier:
              $ref: '#/components/examples/Retrieve_an_API_Product_Order_with_delete_action_from_its_identifier_response'
            Retrieve_an_API_Product_Order_with_add_action_for_a_bundle_ProductOffering_from_its_identifier:
              $ref: '#/components/examples/Retrieve_an_API_Product_Order_with_add_action_for_a_bundle_ProductOffering_from_its_identifier_response'
    '503':
      description: Service Unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Service Unavailable Error
              value:
                '@type': Error
                code: ERR503
                reason: Service Unavailable
                message: The service is currently unavailable. Please try again later.
                referenceError: https://host/errors
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Forbidden Error
              value:
                '@type': Error
                code: ERR403
                reason: Forbidden
                message: You don't have the permission to access the requested resource. It is either read-protected or not readable by the server.
                referenceError: https://host/errors
    200ApiProductOrderArray:
      description: Success
      headers:
        X-Total-Count:
          $ref: '#/components/headers/X-Total-Count'
        X-Result-Count:
          $ref: '#/components/headers/X-Result-Count'
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ApiProductOrder_RES'
          examples:
            Retrieve_a_list_of_API_Product_Order:
              $ref: '#/components/examples/Retrieve_a_list_of_API_Product_Order_response'
            Retrieve_a_list_of_API_Product_Order_with_field_selection_and_filter:
              $ref: '#/components/examples/Retrieve_a_list_of_API_Product_Order_with_field_selection_and_filter_response'
    '409':
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Conflict Error
              value:
                '@type': Error
                code: ERR409
                reason: Conflict
                message: The request could not be completed due to a conflict with the current state of the target resource.
                referenceError: https://host/errors
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Unauthorized Error
              value:
                '@type': Error
                code: ERR401
                reason: Unauthorized
                message: You are not authorized to access the requested resource. Please provide the correct credentials.
                referenceError: https://host/errors
    201ApiProductOrder:
      description: Created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiProductOrder_RES'
          examples:
            Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering:
              $ref: '#/components/examples/Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_response'
            Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product:
              $ref: '#/components/examples/Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product_response'
            Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle:
              $ref: '#/components/examples/Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle_response'
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Bad Request Error
              value:
                '@type': Error
                code: ERR400
                reason: Bad Request
                message: The server could not understand the request due to invalid syntax. Please correct the syntax and try again.
                referenceError: https://host/errors
    '405':
      description: Method Not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Method Not allowed Error
              value:
                '@type': Error
                code: ERR405
                reason: Method Not allowed
                message: The method is not allowed for the requested URL.
                referenceError: https://host/errors
    '404':
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Not Found Error
              value:
                '@type': Error
                code: ERR404
                reason: Not Found
                message: The requested URL was not found on the server.
                referenceError: https://host/errors
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            basic:
              summary: Internal Server Error example
              value:
                '@type': Error
                code: ERR500
                reason: Internal Server Error
                message: The server encountered an internal error. Please contact the system administrator.
                referenceError: https://host/errors
  examples:
    Retrieve_a_list_of_API_Product_Order_response:
      value:
      - '@type': ApiProductOrder
        id: 86387671-0997-461b-99c7-d624ffb0640c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c
        state: completed
        creationDate: '2025-02-02T12:00:00.00Z'
        completionDate: '2025-02-02T12:01:00.00Z'
        externalId:
        - '@type': ExternalIdentifier
          externalIdentifierType: ApplicationOwnerCustomerOrder
          id: order_2232342
          owner: ChannelPartner
        description: Camara API order for an Application Owner
        productOrderItem:
        - '@type': ApiProductOrderItemAdd
          '@baseType': DCSProductOrderItem
          id: '1'
          state: completed
          productOffering:
            '@type': ProductOfferingRef
            id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb
            '@referredType': OpenGatewayProductOffering
          product:
            '@type': ProductRef
            id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb
            href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb
            '@referredType': ApiProduct
          productAction:
            '@type': ApiProductActionAddDeviceLocationVerification
            '@baseType': ApiProductAction
            '@schemaLocation': https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerification_example.schema.json
            purpose: dpv:FraudPreventionAndDetection
            bestAccuracy: 500
            targetApplication:
              '@type': ApplicationRef
              id: f1cba17d-789a-4037-b3e3-2c96e887576c
              href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
              '@referredType': Application
          externalIdentifier:
            '@type': ExternalIdentifier
            externalIdentifierType: ApplicationOwnerProduct
            id: device_location_1234
            owner: ChannelPartner
          approvedProductOfferingTermOrCondition:
          - '@type': ProductOfferingTermOrCondition
            productOfferingTermOrConditionSpecRef:
              '@type': ProductOfferingTermOrConditionSpecRef
              id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1
              '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification
            productOfferingTermOrConditionApproval:
              approvalDate: '2023-11-20T00:00:00.000Z'
            applicationLegalBasisForInputData: dpv:Consent
            process:
            - '@type': DpvProcess
              processingOperation:
              - dpv:Assess
              context:
                '@type': DpvContext
                processingContext:
                - dpv:AutomatedDecisionMaking
                - dpv:AutomatedScoringOfIndividuals
                duration: dpv:FixedOccurrencesDuration
                frequency: dpv:SingularFrequency
              dataExportTransitCountry:
              - '@type': DataExportCountry
                countryCode:
                  '@type': ISO31661Alpha2StandardIdentifier
                  value: US
                commercialOrganizationName: Globy Corporation
                dataPrivacyFrameworkURL: https://www.dataprivacyframework.gov/participant/abcde
            - '@type': DpvProcess
              processingOperation:
              - dpv:Profiling
              context:
                '@type': DpvContext
                processingContext:
                - dpv:AutomatedScoringOfIndividuals
                duration: dpv:EndlessDuration
                frequency: dpv:SingularFrequency
              dataExportTransitCountry:
              - '@type': DataExportCountry
                countryCode:
                  '@type': ISO31661Alpha2StandardIdentifier
                  value: US
                commercialOrganizationName: Globy Corporation
                dataPrivacyFrameworkURL: https://www.dataprivacyframework.gov/participant/abcde
              dataExportStorageCountry:
              - '@type': DataExportCountry
                countryCode:
                  '@type': ISO31661Alpha2StandardIdentifier
                  value: US
                commercialOrganizationName: Globy Corporation
                dataPrivacyFrameworkURL: https://www.dataprivacyframework.gov/participant/abcde
            userConsentScreenshot:
              '@type': SimpleAttachment
              content: JVBERi...JSVFT0Y=
              mimeType: application/pdf
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      - '@type': ApiProductOrder
        id: d86065be-f2fd-490b-bb6a-dca24cc7f65a
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/d86065be-f2fd-490b-bb6a-dca24cc7f65a
        state: completed
        creationDate: '2025-03-02T12:00:00.00Z'
        completionDate: '2025-03-02T12:01:00.00Z'
        externalId:
        - '@type': ExternalIdentifier
          externalIdentifierType: ApplicationOwnerCustomerOrder
          id: order_2232342
          owner: ChannelPartner
        description: Camara API Unsubscription for an Application Owner
        productOrderItem:
        - '@type': ProductOrderItemDelete
          '@baseType': DCSProductOrderItem
          '@schemaLocation': https://mycsp.com/tmf-api/schema/Customer/ApiProductOrderItemDelete.schema.json
          id: '1'
          state: completed
          product:
            '@type': ProductRef
            id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb
            href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb
            '@referredType': ApiProduct
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      - '@type': ApiProductOrder
        id: c5c005c5-34f9-4e7d-99df-8a30da246f8b
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b
        state: completed
        creationDate: '2025-01-01T10:00:00.00Z'
        completionDate: '2025-01-01T10:01:00.00Z'
        externalId:
        - '@type': ExternalIdentifier
          externalIdentifierType: ApplicationOwnerCustomerOrder
          id: order_6453
          owner: ChannelPartner
        productOrderItem:
        - '@type': ApiProductOrderItemAdd
          '@baseType': DCSProductOrderItem
          state: completed
          id: '1'
          productOffering:
            '@type': ProductOfferingRef
            id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a
            '@referredType': OpenGatewayProductOffering
          product:
            '@type': ProductRef
            href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/33944716-d86f-4122-827b-307d74e6ca50
            id: 33944716-d86f-4122-827b-307d74e6ca50
            '@referredType': ApiProduct
          productAction:
            '@type': ApiProductActionAdd
            targetApplication:
              '@type': ApplicationRef
              id: f1cba17d-789a-4037-b3e3-2c96e887576c
              href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
              '@referredType': Application
          externalIdentifier:
            '@type': ExternalIdentifier
            externalIdentifierType: ApplicationOwnerProduct
            id: device_location_bund

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-gateway/refs/heads/main/openapi/open-gateway-apiproductorder-api-openapi.yml