Aeris Order management API

openapi: 3.2.0
info:
  title: Order management API
  description: '#### Copyright

    @ Aeris Communications, Inc.'
  version: 1.0.1
  x-api-id: 3c82242f-95ff-4484-b84a-c96a9b2c43d3
  x-audience: external-partner
servers:
- url: https://iot-api.aeris.com/iot/api
  description: API server
tags:
- name: Order Management
  description: Order management APIs.
paths:
  /orders:
    get:
      tags:
      - Order Management
      summary: Get order list
      description: Query order list.
      operationId: getOrderList
      parameters:
      - name: cursor
        in: query
        description: "Opaque string returned within the meta object response on endpoints which support pagination.\n Indicates that more results are available and can be used as the 'cursor' parameter in the next request to return the next page of results.\n  The last page of results will not have a 'next' present.\n"
        schema:
          type: string
        example: DFVSDB3434%DFB%EYY445
      - name: limit
        in: query
        description: The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
        schema:
          type: integer
          example: 100
          default: 100
      - name: q
        in: query
        description: "Filter parameter which supports the RSQL filter syntax.\nRSQL is a super-set of the Feed Item Query Language (FIQL).\nNote! The query string must be URL encoded.\nSupported fields:\n  - status\n  - type\n"
        schema:
          type: string
          example: status==DRAFT;type==CREATE_2G3G_RP
      responses:
        '200':
          description: OK
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderListResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_view_order
    post:
      tags:
      - Order Management
      summary: Create an order to create, update, delete or deprecate network resources and…
      description: This API is used to create a new order. Parameter "type" indicates the purpose.
      operationId: postOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostOrderRequest'
            examples:
              Create order to create 2G3G roaming profile:
                $ref: '#/components/examples/Create2g3gRoamingProfileExample'
              Create order to update 2G3G roaming profile:
                $ref: '#/components/examples/Update2g3gRoamingProfileExample'
              Create order to create 4G roaming profile:
                $ref: '#/components/examples/Create4gRoamingProfileExample'
              Create order to update 4G roaming profile:
                $ref: '#/components/examples/Update4gRoamingProfileExample'
              Create order to create dedicated internet data service:
                $ref: '#/components/examples/CreateDedicatedInternetServiceExample'
              Create order to update dedicated internet data service:
                $ref: '#/components/examples/UpdateDedicatedInternetServiceExample'
              Create order to create sim specification:
                $ref: '#/components/examples/CreateSimSpecificationExample'
              Create order to update sim specification:
                $ref: '#/components/examples/UpdateSimSpecificationExample'
              Create order to create form specification:
                $ref: '#/components/examples/CreateFormSpecificationExample'
              Create order to update form specification:
                $ref: '#/components/examples/UpdateFormSpecificationExample'
              Create order to create profile specification:
                $ref: '#/components/examples/CreateProfileSpecificationExample'
              Create order to update profile specification:
                $ref: '#/components/examples/UpdateProfileSpecificationExample'
              Create order to delete inventory item:
                $ref: '#/components/examples/DeleteInventoryExample'
        required: true
      responses:
        '201':
          description: Created
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOrderResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_manage_order
  /orders/{id}:
    get:
      tags:
      - Order Management
      summary: Query the order detail by id
      description: Get the order detail information by order id
      operationId: getOrderById
      parameters:
      - name: id
        in: path
        description: the id of order
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderResponse'
              examples:
                Get 2G3G roaming profile order:
                  $ref: '#/components/examples/Get2g3gRoamingProfileExample'
                Get 4G roaming profile order:
                  $ref: '#/components/examples/Get4gRoamingProfileExample'
                Get dedicated internet service order:
                  $ref: '#/components/examples/GetDedicatedInternetServiceExample'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '404':
          description: Not Found
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NotFound'
              example:
                type: https://your.api.documentation.url
                title: Not Found
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_view_order
    delete:
      tags:
      - Order Management
      summary: Delete an order which is in "DRAFT" or "CANCELED" status
      description: Only DRAFT or CANCELED order can be deleted.
      operationId: deleteOrderById
      parameters:
      - name: id
        in: path
        description: the id of order
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '404':
          description: Not Found
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NotFound'
              example:
                type: https://your.api.documentation.url
                title: Not Found
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_manage_order
    patch:
      tags:
      - Order Management
      summary: Update an order which has not been fulfilled
      description: Update, partial replacement of an order, only mentioned fields are expected to be updated.
      operationId: patchOrderById
      parameters:
      - name: id
        in: path
        description: the id of order
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/PatchOrderRequest'
            examples:
              Patch 2G3G roaming profile:
                $ref: '#/components/examples/Patch2g3gRoamingProfileExample'
              Patch 4G roaming profile:
                $ref: '#/components/examples/Patch4gRoamingProfileExample'
              Patch dedicated internet service order:
                $ref: '#/components/examples/PatchDedicatedInternetServiceExample'
      responses:
        '204':
          description: No Content
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '404':
          description: Not Found
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NotFound'
              example:
                type: https://your.api.documentation.url
                title: Not Found
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_manage_order
  /orders/{id}/actions:
    post:
      tags:
      - Order Management
      summary: Post actions on order
      description: 'Post actions on order to trigger the order flow moving forward.


        SUBMIT: Submit an order for approval or implmentation


        CANCEL: Cancel an order


        APPROVE: Approve an order


        REJECT: Reject an order


        ACCEPT_VERIFICATION: Customers accept the verification when the implementation is done. The order will be closed successfully


        REJECT_VERIFICATION: Customers reject the verification when the implementation is done. The problems will be addressed and fixed by the operation team'
      operationId: postOrderActionById
      parameters:
      - name: id
        in: path
        description: the id of order
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostActionsRequest'
            examples:
              Submit order:
                value:
                  action: SUBMIT
              Cancel order:
                value:
                  action: CANCEL
              Approve order:
                value:
                  action: APPROVE
                  comments: OK
              Reject order:
                value:
                  action: REJECT
                  comments: Something wrong
              Accept verification:
                value:
                  action: ACCEPT_VERIFICATION
                  comments: OK
              Reject verification:
                value:
                  action: REJECT_VERIFICATION
                  comments: Something wrong
      responses:
        '204':
          description: No Content
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '404':
          description: Not Found
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/NotFound'
              example:
                type: https://your.api.documentation.url
                title: Not Found
                status: 404
                detail: The server has not found anything matching the Request-URI.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_manage_order
        - om_resource_approval
        - om_service_approval
  /orders/approvals:
    get:
      tags:
      - Order Management
      summary: Get order approval list
      description: Query order approval list.
      operationId: getApprovalList
      parameters:
      - name: q
        in: query
        description: "Filter parameter which supports the RSQL filter syntax.\nRSQL is a super-set of the Feed Item Query Language (FIQL).\nNote! The query string must be URL encoded.\nSupported fields:\n  - status\n  - approvalStage\n  - order.id\n  - order.type\n  - order.orderedFor\n"
        schema:
          type: string
          example: status==PENDING;approvalStage==OPERATOR
      - name: cursor
        in: query
        description: "Opaque string returned within the meta object response on endpoints which support pagination.\n Indicates that more results are available and can be used as the 'cursor' parameter in the next request to return the next page of results.\n  The last page of results will not have a 'next' present.\n"
        schema:
          type: string
        example: DFVSDB3434%DFB%EYY445
      - name: limit
        in: query
        description: The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
        schema:
          type: integer
          example: 100
          default: 100
      responses:
        '200':
          description: OK
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApprovalListResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_view_order
  /orders/revisions:
    get:
      tags:
      - Order Management
      summary: Get order revision list
      description: Query order revision list.
      operationId: getRevisionList
      parameters:
      - name: q
        in: query
        description: "Filter parameter which supports the RSQL filter syntax.\nRSQL is a super-set of the Feed Item Query Language (FIQL).\nNote! The query string must be URL encoded.\nSupported fields:\n  - status\n  - revisionStage\n  - order.id\n  - order.type\n  - order.orderedFor\n"
        schema:
          type: string
          example: status==PENDING;revisionStage==OPERATOR
      - name: cursor
        in: query
        description: "Opaque string returned within the meta object response on endpoints which support pagination.\n Indicates that more results are available and can be used as the 'cursor' parameter in the next request to return the next page of results.\n  The last page of results will not have a 'next' present.\n"
        schema:
          type: string
        example: DFVSDB3434%DFB%EYY445
      - name: limit
        in: query
        description: The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
        schema:
          type: integer
          example: 100
          default: 100
      responses:
        '200':
          description: OK
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRevisionListResponse'
        '400':
          description: Bad Request
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Bad Request
                status: 400
                detail: Invalid request parameter
                instance: https://hostname/iot/api/some-path
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Unauthorized
                status: 401
                detail: The request has not been applied because the server requires user authentication.
                instance: https://hostname/iot/api/some-path
        '429':
          description: Too Many Requests
          allOf:
          - $ref: '#/components/responses/RateLimitedResponse'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error.
          headers:
            Content-Type:
              $ref: '#/components/headers/Content-Type'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://your.api.documentation.url
                title: Internal Server Error
                status: 500
                detail: The server has encountered a situation that it does not know how to handle.
                instance: https://hostname/iot/api/some-path
        default:
          description: Internal Server Error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
      - oauth2:
        - om_view_order
  /orders/verifications:
    get:
      tags:
      - Order Management
      summary: Get order verification list
      description: Query order verification list.
      operati

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