Optum

Optum Order Management API

The Order Management API from Optum — 10 operation(s) for order management.

GitHub OpenAPI

Operations 10

POST /om/placeOrder Legacy API to Place an order to NCC #
GET /om/clientOrderDetails Legacy API to fetch Client Order Details in NCC #
GET /om/clientOrderStatus Legacy API to fetch Client order status in NCC #
GET /om/vendorOrderDetails Legacy API to fetch Vendor Order Details in NCC #
GET /om/vendorOrderStatus Legacy API to fetch Vendor order status in NCC #
POST /om/v1/client-orders API to Place an order for internal and external vendors to NCC #
GET /om/v1/client-orders/{orderId} API to fetch Client Order Details in NCC #
GET /om/v1/client-orders/{orderId}/status API to fetch Client order status in NCC #
GET /om/v1/vendor-orders/{vendorOrderId} API to fetch Vendor Order Details in NCC #
GET /om/v1/vendor-orders/{vendorOrderId}/status API to fetch Vendor order status in NCC #

Documentation

📖
APIReference
https://developer.optum.com/eligibilityandclaims/reference/api-overview
📖
GettingStarted
https://developer.optum.com/eligibilityandclaims/docs/get-started-with-optum-api
📖
Authentication
https://developer.optum.com/eligibilityandclaims/docs/optum-security-and-authorization
📖
APIReference
https://developer.optum.com/optumreal-dental/reference/overview-real-dental
📖
GettingStarted
https://developer.optum.com/optumreal-dental/reference/get-started
📖
APIReference
https://developer.optum.com/pharmacysolutions/reference
📖
APIReference
https://developer.optum.com/paymentandreimbursement/reference
📖
APIReference
https://developer.optum.com/platformandinteroperability/reference
📖
APIReference
https://developer.optum.com/analyticsandinsights/reference
📖
APIReference
https://developer.optum.com/apitools/reference/security-and-authorization-v2-overview
📖
Documentation
https://developer.optum.com/apitools/docs/getting-started

Specifications

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

Other Resources

🔗
ChangeLog
https://developer.optum.com/eligibilityandclaims/docs/eligibility-release-notes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optum-order-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optum-order-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NCC Data Acquisition Order Management API
  version: 1.0.0
  description: 'The National Clinical Clearing(NCC) Data Acquisition API provides users with a REST-based solution for requesting and receiving clinical data from the chosen data vendor through the NCC platform. Authentication: All API''s requires JWT based authentication.'
servers:
- url: https://gateway-nonprod.optuminsightplatform.com/odxcloudapigatewaypreprod/ncc
  variables: {}
  description: Pre Prod
- url: https://gateway.optuminsightplatform.com/odxcloudapigateway/ncc
  variables: {}
  description: Prod
tags:
- name: Order Management
paths:
  /om/placeOrder:
    post:
      summary: Legacy API to Place an order to NCC
      description: To place a new order to NCC, please use /placeOrder legacy API. This API  would need         to have the pre-defined order components from the pre-requisite set up         and the uploaded roster file to the defined ECG location.
      operationId: placeOrder
      security:
      - bearerAuth: []
      requestBody:
        required: true
        description: 'placeOrderRequest: Reques objct for the placeOrder api, please see schema for details'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaceOrderRequest'
            examples:
              placeOrderRequest:
                value:
                  clientOrgId: '2301320'
                  tenantId: '2300980'
                  clientOrderName: Test Order Name 001
                  serviceStartDate: '2023-06-01T08:06:39.307'
                  serviceEndDate: '2023-06-10T08:06:39.307'
                  vendors:
                  - vendorName: Athena
                    vendorOrgId: '2301025'
                    interfaces:
                    - 2.16.840.1.113883.3.2966.1000.1005.152.3.95
                  campaignId: 1084
                  campaignName: 2021 PRO-1QWERTY-11
                  requestingPartyId: 1074
                  requestingPartyName: Optum
                  rosterFilePath: quarantine/original-roster-20211215-203035-cleanroster-int123334567.csv
      responses:
        '200':
          description: Place Order Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponsePlaceOrderResponse'
              examples:
                placeOrderResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 3000
                      orderStatus: ORDER_PLACED
        '400':
          description: Bad Request. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access Place order API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to place order in NCC, internal server error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/clientOrderDetails:
    get:
      summary: Legacy API to fetch Client Order Details in NCC
      description: To fetch client order details in NCC, please use /clientOrderDetails legacy API.
      operationId: getClientOrderDetails
      parameters:
      - name: clientOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Fetch Client Order Details Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseClientOrderDetailsResponse'
              examples:
                clientOrderDetailsResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 6601
                      clientOrderSubmittedDate: '2023-06-30T05:12:20.653'
                      clientOrderStatus: In Progress
                      clientOrderStatusDetail: EIMP_MATCHING_COMPLETE
                      vendorOrders:
                      - vendorOrgId: 2002000
                        vendorOrgName: EPP
                        vendorOrderId: 6000
                        vendorOrderStatus: Complete
                        vendorOrderStatusDetail: ALL_REQUESTS_SUBMITTED_FOR_OUTBOUND
                        orderResult:
                          cleanMetric:
                            count: 1655
                            downloadUrl: https://odxcentralusakspreprod.blob.core.windows.net/data-acquisition-roster-management-preprod/rosters%2F2023%2F06%2F30%2F6601%2Fgood%2FV2_1K_with_POU_6601_Clean.csv?sv=2021-12-02&st=2023-07-07T07%3A45%3A15Z&se=2023-07-07T07%3A50%3A15Z&sr=b&sp=r&sig=NTHOBdfMU%2FQhdaY6fPpd5sAzda1JtkaxR%2FNBkLrKo1U%3D
                          errorMetric:
                            count: 2
                            downloadUrl: https://odxcentralusakspreprod.blob.core.windows.net/data-acquisition-roster-management-preprod/rosters%2F2023%2F06%2F30%2F6601%2Fbad%2FV2_1K_with_POU_6601_Errors.csv?sv=2021-12-02&st=2023-07-07T07%3A45%3A15Z&se=2023-07-07T07%3A50%3A15Z&sr=b&sp=r&sig=IF%2F5KGsx3NeI4TzZQqUkvyTiqMTn6vMMXUZ5hA7Tgm8%3D
        '400':
          description: Bad Request. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access client order details API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to retrieve given client order details, internal server error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/clientOrderStatus:
    get:
      summary: Legacy API to fetch Client order status in NCC
      description: To fetch client order status in  NCC, please use /clientOrderStatus legacy API.
      operationId: getClientOrderStatus
      security:
      - bearerAuth: []
      parameters:
      - name: clientOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Fetch Client Order Status Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseClientOrderStatusResponse'
              examples:
                clientOrderStatusResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 6601
                      clientOrderStatus: In Progress
                      clientOrderStatusDetail: EIMP_MATCHING_COMPLETE
        '400':
          description: Bad Request, Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access client order status API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to retrieve given client order status , Internal server error occured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/vendorOrderDetails:
    get:
      summary: Legacy API to fetch Vendor Order Details in NCC
      description: To fetch vendor order details in NCC, please use /vendorOrderDetails legacy API.
      operationId: getVendorOrderDetails
      security:
      - bearerAuth: []
      parameters:
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: vendorOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Fetch Vendor Order Details Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseVendorOrderDetailsResponse'
              examples:
                vendorOrderDetailsResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 3000
                      vendorOrderId: 4000
                      vendorOrgId: 2301320
                      vendorOrgName: Athena
                      vendorOrderStatus: Complete
                      vendorOrderStatusDetail: ALL_REQUESTS_SUBMITTED_FOR_OUTBOUND
                      submissionDate: '2023-07-06T08:06:39.307'
                      vendorOrderExpDate: '2023-07-06T18:06:39.307'
                      newExpirationDate: '2023-07-06T28:06:39.307'
        '400':
          description: Bad Request. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access vendor order details API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to retrieve given vendor order details, internal server error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/vendorOrderStatus:
    get:
      summary: Legacy API to fetch Vendor order status in NCC
      description: To fetch vendor order status in NCC, please use /vendorOrderStatus legacy API.
      operationId: getVendorOrderStatus
      security:
      - bearerAuth: []
      parameters:
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: vendorOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Fetch Vendor Order Status Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseVendorOrderStatusResponse'
              examples:
                vendorOrderStatusResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 6601
                      vendorOrderId: 8064
                      vendorOrderStatus: Complete
                      vendorOrderStatusDetail: ALL_REQUESTS_SUBMITTED_FOR_OUTBOUND
        '400':
          description: Bad Request, Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access vendor order status API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to retrieve given vendor order status , Internal server error occured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/v1/client-orders:
    post:
      summary: API to Place an order for internal and external vendors to NCC
      description: To place a new order to NCC, please use /v1/client-orders API. This API would need to have the pre-defined order components from the pre-requisite set up and the uploaded roster file to the defined ECG location.
      operationId: v1CreateClientOrder
      security:
      - bearerAuth: []
      requestBody:
        required: true
        description: 'ClientOrderRequest: Request object for the client-orders api, please see schema for details'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/clientOrderRequest'
            examples:
              clientOrderRequest-external:
                value:
                  vendorType: external
                  clientOrgId: '2301320'
                  tenantId: '2300980'
                  clientOrderName: Test Order Name 001
                  serviceStartDate: '2023-06-01'
                  serviceEndDate: '2023-06-11'
                  vendors:
                  - vendorName: Athena
                    vendorOrgId: '2301025'
                    interfaces:
                    - 2.16.840.1.113883.3.2966.1000.1005.152.3.95
                  campaignId: 1084
                  campaignName: 2021 PRO-1QWERTY-11
                  requestingPartyId: 1074
                  requestingPartyName: Optum
                  rosterFilePath: quarantine/original-roster-20211215-203035-cleanroster-int123334567.csv
              clientOrderRequest-internal:
                value:
                  vendorType: internal
                  clientOrgId: '2301320'
                  tenantId: '2300980'
                  clientOrderName: Test Order Name 001
                  serviceStartDate: '2023-06-01'
                  serviceEndDate: '2023-06-10'
                  vendors:
                  - vendorOrgId: '201307'
                    vendorName: Ecdh
                    interfaces:
                    - 2.16.840.1.113883.3.2966.1000.1005.152.1.806
                    subVendorNames:
                    - Athena
                    - Veradigm
                  campaignId: 1084
                  campaignName: 2021 PRO-1QWERTY-11
                  requestingPartyId: 1074
                  requestingPartyName: Optum
                  rosterFilePath: quarantine/original-roster-20211215-203035-cleanroster-int123334567.csv
              clientOrderRequest-internalForAllSubVendors:
                value:
                  vendorType: internal
                  clientOrgId: '2301320'
                  tenantId: '2300980'
                  clientOrderName: Test Order Name 001
                  serviceStartDate: '2023-06-01'
                  serviceEndDate: '2023-06-10'
                  vendors:
                  - vendorOrgId: '201307'
                    vendorName: Ecdh
                    interfaces:
                    - 2.16.840.1.113883.3.2966.1000.1005.152.1.806
                  campaignId: 1084
                  campaignName: 2021 PRO-1QWERTY-11
                  requestingPartyId: 1074
                  requestingPartyName: Optum
                  rosterFilePath: quarantine/original-roster-20211215-203035-cleanroster-int123334567.csv
      responses:
        '200':
          description: Place Client Order Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseClientOrderResponse'
              examples:
                clientOrderResponse:
                  value:
                    status: 200
                    result:
                      clientOrderId: 3000
                      clientOrderStatus: ORDER_ACCEPTED
                      statusMessage: CLIENT_ORDER_CREATED
        '400':
          description: Bad Request. Some issue in the properties supplied to the API. For example Invalid vendor details, special chars in client order name, invalid vendor type, roster file not present in ABS etc.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest-fileNotPresent:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: FAILED
                      detail:
                        code: API_ERROR_INVALID_REQUEST
                        message: 'Error validating request: [The specified file quarantine/EiMP_members_Roster_Test_V2.csv is not present in blob storage. Hence the request will be rejected.]'
        '401':
          description: User is unauthorized to access Place client order API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                unauthorized:
                  value:
                    status: 401
                    statusMessage: Unauthorized
                    error:
                      status: FAILED
                      detail:
                        code: AUTHENTICATION
                        message: Jwt expired at 2023-12-06T19:23:03Z
        '500':
          description: Application failed to place order in NCC, internal server error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalServerError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
      tags:
      - Order Management
  /om/v1/client-orders/{orderId}:
    get:
      summary: API to fetch Client Order Details in NCC
      description: To fetch client order details in NCC, please use /client-orders/{orderId} API.
      operationId: v1GetClientOrderDetails
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Fetch Client Order Details Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseClientOrderDetailsResponse'
              examples:
                clientOrderDetailsResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 6601
                      clientOrderSubmittedDate: '2023-06-30T05:12:20.653'
                      clientOrderStatus: In Progress
                      clientOrderStatusDetail: EIMP_MATCHING_COMPLETE
                      vendorOrders:
                      - vendorOrgId: 2002000
                        vendorOrgName: EPP
                        vendorOrderId: 6000
                        vendorOrderStatus: Complete
                        vendorOrderStatusDetail: ALL_REQUESTS_SUBMITTED_FOR_OUTBOUND
                        orderResult:
                          cleanMetric:
                            count: 1655
                            downloadUrl: https://odxcentralusakspreprod.blob.core.windows.net/data-acquisition-roster-management-preprod/rosters%2F2023%2F06%2F30%2F6601%2Fgood%2FV2_1K_with_POU_6601_Clean.csv?sv=2021-12-02&st=2023-07-07T07%3A45%3A15Z&se=2023-07-07T07%3A50%3A15Z&sr=b&sp=r&sig=NTHOBdfMU%2FQhdaY6fPpd5sAzda1JtkaxR%2FNBkLrKo1U%3D
                          errorMetric:
                            count: 2
                            downloadUrl: https://odxcentralusakspreprod.blob.core.windows.net/data-acquisition-roster-management-preprod/rosters%2F2023%2F06%2F30%2F6601%2Fbad%2FV2_1K_with_POU_6601_Errors.csv?sv=2021-12-02&st=2023-07-07T07%3A45%3A15Z&se=2023-07-07T07%3A50%3A15Z&sr=b&sp=r&sig=IF%2F5KGsx3NeI4TzZQqUkvyTiqMTn6vMMXUZ5hA7Tgm8%3D
        '400':
          description: Bad Request. Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access client order details API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to retrieve given client order details, internal server error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/v1/client-orders/{orderId}/status:
    get:
      summary: API to fetch Client order status in NCC
      description: To fetch client order status in  NCC, please use /client-orders/{orderId}/status API.
      operationId: v1GetClientOrderStatus
      security:
      - bearerAuth: []
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Fetch Client Order Status Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseClientOrderStatusResponse'
              examples:
                clientOrderStatusResponse:
                  value:
                    status: 200
                    statusMessage: SUCCESS
                    result:
                      clientOrderId: 6601
                      clientOrderStatus: In Progress
                      clientOrderStatusDetail: EIMP_MATCHING_COMPLETE
        '400':
          description: Bad Request, Please try again
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                badRequest:
                  value:
                    status: 400
                    statusMessage: Bad Request
                    error:
                      status: BAD_REQUEST
                      detail:
                        message: '{"status":"FAILED","error":{"code":"API_ERROR_BAD_REQUEST"}}'
        '401':
          description: User is unauthorized to access client order status API
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    format: int64
                  error:
                    type: string
              examples:
                authError:
                  value:
                    error: Token is expired
                    status: 401
        '500':
          description: Application failed to retrieve given client order status , Internal server error occured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              examples:
                internalError:
                  value:
                    status: 500
                    statusMessage: Internal Server Error
                    error:
                      status: INTERNAL_SERVER_ERROR
                      detail:
                        message: '{"status":"FAILED","error":{"code":"INTERNAL_SERVER_ERROR"}}'
      tags:
      - Order Management
  /om/v1/vendor-orders/{vendorOrderId}:
    get:
      summary: API to fetch Vendor Order Details in NCC
      description: To fetch vendor order details in NCC, please use /vendor-orders/{vendorOrderId} API.
      operationId: v1GetVendorOrderDetails
      security:
      - bearerAuth: []
      parameters:
      - name: tenantId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrgId
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: clientOrderId
        in: query
        required: true
        schema:
          type: integer
          format: int64
      - name: vendorOrderId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Fetch Vendor Order Details Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseVendorOrderDetailsResponse'
              examples:
                vendorOrderDetailsResponse:
                  value

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