{
  "openapi": "3.0.0",
  "info": {
    "title": "att-order-status-eapi",
    "version": "v1"
  },
  "paths": {
    "/order-enrichment/installation-shipping-apex": {
      "post": {
        "summary": "Installation Shipping Enrichment",
        "description": "This API allows users to enrich order details related to installation and shipping.",
        "parameters": [
          {
            "name": "content-type",
            "in": "header",
            "description": "application/json",
            "required": true,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "accept",
            "in": "header",
            "description": "Specifies the format of the response message body. Structured text message payloads are required to support application/json.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "x-trace-id",
            "in": "header",
            "description": "This field is used for passing a trace ID between API hops for end-to-end traceability.",
            "required": true,
            "schema": {
              "type": "string",
              "example": "givingXTracing123456"
            }
          },
          {
            "name": "x-transaction-id",
            "in": "header",
            "description": "This field is used for passing a traceable Id to uniquely identify the transactions.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "1234"
            }
          },
          {
            "name": "client_id",
            "in": "header",
            "description": "This field represents the client id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "client_secret",
            "in": "header",
            "description": "This field represents the client secret.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "header",
            "description": "This field should identify the calling system/application.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/installationShippingRequest"
              }
            }
          }
        },
        "x-page-slug": "installation-shipping-slug",
        "responses": {
          "200": {
            "description": "Your request was processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/installationShippingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "401": {
            "description": "Not Authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "404": {
            "description": "Requested resource not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error / INVALID_SP / UNAUTHORIZED_SP",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          }
        }
      }
    },
    "/order-enrichment/apexRDSProdandPortReserve": {
      "post": {
        "summary": "RDS Product and Port Reserve",
        "description": "This API allows users to gather the required information to perform RDS product validation and port reservation.",
        "parameters": [
          {
            "name": "content-type",
            "in": "header",
            "description": "application/json",
            "required": true,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "accept",
            "in": "header",
            "description": "Specifies the format of the response message body. Structured text message payloads are required to support application/json.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "x-trace-id",
            "in": "header",
            "description": "This field is used for passing a trace ID between API hops for end-to-end traceability.",
            "required": true,
            "schema": {
              "type": "string",
              "example": "givingXTracing123456"
            }
          },
          {
            "name": "x-transaction-id",
            "in": "header",
            "description": "This field is used for passing a traceable Id to uniquely identify the transactions.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "1234"
            }
          },
          {
            "name": "client_id",
            "in": "header",
            "description": "This field represents the client id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "client_secret",
            "in": "header",
            "description": "This field represents the client secret.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "header",
            "description": "This field should identify the calling system/application.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/rdsPortReserveRequest"
              }
            }
          }
        },
        "x-page-slug": "rds-port-reserve-slug",
        "responses": {
          "200": {
            "description": "Your request was processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rdsPortReserveResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "401": {
            "description": "Not Authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "404": {
            "description": "Requested resource not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error / INVALID_SP / UNAUTHORIZED_SP",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          }
        }
      }
    },
    "/order-enrichment/newBilling-apex": {
      "post": {
        "summary": "New Billing",
        "description": "This API allows users to collect billing details associated with the order.",
        "parameters": [
          {
            "name": "content-type",
            "in": "header",
            "description": "application/json",
            "required": true,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "accept",
            "in": "header",
            "description": "Specifies the format of the response message body. Structured text message payloads are required to support application/json.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "x-trace-id",
            "in": "header",
            "description": "This field is used for passing a trace ID between API hops for end-to-end traceability.",
            "required": true,
            "schema": {
              "type": "string",
              "example": "givingXTracing123456"
            }
          },
          {
            "name": "x-transaction-id",
            "in": "header",
            "description": "This field is used for passing a traceable Id to uniquely identify the transactions.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "1234"
            }
          },
          {
            "name": "client_id",
            "in": "header",
            "description": "This field represents the client id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "client_secret",
            "in": "header",
            "description": "This field represents the client secret.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "header",
            "description": "This field should identify the calling system/application.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/newBillingRequest"
              }
            }
          }
        },
        "x-page-slug": "new-billing-slug",
        "responses": {
          "200": {
            "description": "Your request was processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/newBillingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "401": {
            "description": "Not Authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "404": {
            "description": "Requested resource not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error / INVALID_SP / UNAUTHORIZED_SP",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          }
        }
      }
    },
    "/order-apex": {
      "post": {
        "summary": "Create Order",
        "description": "This API allows users to process order details and create a new order.",
        "parameters": [
          {
            "name": "content-type",
            "in": "header",
            "description": "application/json",
            "required": true,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "accept",
            "in": "header",
            "description": "Specifies the format of the response message body. Structured text message payloads are required to support application/json.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "x-trace-id",
            "in": "header",
            "description": "This field is used for passing a trace ID between API hops for end-to-end traceability.",
            "required": true,
            "schema": {
              "type": "string",
              "example": "givingXTracing123456"
            }
          },
          {
            "name": "x-transaction-id",
            "in": "header",
            "description": "This field is used for passing a traceable Id to uniquely identify the transactions.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "1234"
            }
          },
          {
            "name": "client_id",
            "in": "header",
            "description": "This field represents the client id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "client_secret",
            "in": "header",
            "description": "This field represents the client secret.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "header",
            "description": "This field should identify the calling system/application.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/orderApexRequest"
              }
            }
          }
        },
        "x-page-slug": "order-apex-slug",
        "responses": {
          "200": {
            "description": "Your request was processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/orderApexResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "401": {
            "description": "Not Authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "404": {
            "description": "Requested resource not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error / INVALID_SP / UNAUTHORIZED_SP",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          }
        }
      }
    },
    "/order-enrichment/order-enrichment-status": {
      "get": {
        "summary": "Order Enrichment Status",
        "description": "This API allows users to retrieve the status of enrichment for an Apex ADI product.",
        "parameters": [
          {
            "name": "subOrderId",
            "in": "query",
            "description": "Unique identifier for the sub-order.",
            "required": true,
            "schema": {
              "type": "string",
              "example": "801dx00000Z8bayAAB"
            }
          },
          {
            "name": "accept",
            "in": "header",
            "description": "Specifies the format of the response message body. Structured text message payloads are required to support application/json.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "application/json"
            }
          },
          {
            "name": "x-trace-id",
            "in": "header",
            "description": "This field is used for passing a trace ID between API hops for end-to-end traceability.",
            "required": true,
            "schema": {
              "type": "string",
              "example": "givingXTracing123456"
            }
          },
          {
            "name": "x-transaction-id",
            "in": "header",
            "description": "This field is used for passing a traceable Id to uniquely identify the transactions.",
            "required": false,
            "schema": {
              "type": "string",
              "example": "1234"
            }
          },
          {
            "name": "client_id",
            "in": "header",
            "description": "This field represents the client id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "client_secret",
            "in": "header",
            "description": "This field represents the client secret.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source",
            "in": "header",
            "description": "This field should identify the calling system/application.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "x-page-slug": "order-enrichment-status-slug",
        "responses": {
          "200": {
            "description": "Your request was processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/orderEnrichmentStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "401": {
            "description": "Not Authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "404": {
            "description": "Requested resource not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error / INVALID_SP / UNAUTHORIZED_SP",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StandardError"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "Contact DL-APS_API_Services@att.com to get Endpoint details "
    }
  ],
  "components": {
    "schemas": {
      "StandardError": {
        "title": "Standard Error Response Item",
        "description": "Error Response",
        "x-amf-examples": {
          "example_2": {
            "node": "Store location System API",
            "code": 405,
            "message": "METHOD_NOT_ALLOWED",
            "description": "The method received in the request-line is known by the origin server but not supported by the target resource.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "DATA ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "amf_example_1": {
            "node": "Store location System API",
            "code": 403,
            "message": "FORBIDDEN",
            "description": "The server understood the request but refuses to authorize it. The client MAY repeat the request with new or different credentials.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "SYSTEM ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "example_1": {
            "node": "Store location System API",
            "code": 401,
            "message": "NOT_AUTHORIZED",
            "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "DATA ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "amf_example_2": {
            "node": "Store location System API",
            "code": 404,
            "message": "RESOURCE_NOT_FOUND",
            "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "DATA ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "amf_example_4": {
            "node": "Store location System API",
            "code": 500,
            "message": "INTERNAL_SERVER_ERROR",
            "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "SYSTEM ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "example_0": {
            "node": "Store location System API",
            "code": 400,
            "message": "BAD_REQUEST",
            "description": "The server cannot or will not process the request due to something that is perceived to be a client error.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "DATA ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "amf_example_3": {
            "node": "Store location System API",
            "code": 406,
            "message": "NOT_ACCEPTABLE",
            "description": "The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "SYSTEM ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          },
          "example_3": {
            "node": "Store location System API",
            "code": 415,
            "message": "UNSUPPORTED_MEDIA_TYPE",
            "description": "The format problem might be due to the request's indicated Content-Type or Content-Encoding, or as a result of inspecting the data directly.",
            "transactionId": "803ec5202bd54576992d082da70e6338",
            "traceId": "712def66-c54a-11ea-87d0-0242ac130003",
            "error_context": {
              "time": "2021-07-29T01:51:15.000Z",
              "type": "DATA ERROR",
              "category": "Account",
              "payload": {},
              "error_identifier": "123",
              "action": "create"
            }
          }
        },
        "type": "object",
        "required": [
          "node",
          "code",
          "message",
          "description",
          "transactionId",
          "traceId"
        ],
        "properties": {
          "node": {
            "description": "API Name",
            "example": "Store location System API",
            "type": "string"
          },
          "code": {
            "description": "Status Code",
            "example": 401,
            "type": "number"
          },
          "message": {
            "description": "Error Message",
            "example": "NOT_AUTHORIZED",
            "type": "string"
          },
          "description": {
            "description": "Error Description",
            "example": "The request has not been applied because it lacks valid authentication credentials for the target resource.",
            "type": "string"
          },
          "transactionId": {
            "description": "Transaction ID",
            "example": "803ec5202bd54576992d082da70e6338",
            "type": "string"
          },
          "traceId": {
            "description": "Trace ID",
            "example": "712def66-c54a-11ea-87d0-0242ac130003",
            "type": "string"
          },
          "error_context": {
            "type": "object",
            "required": [
              "time",
              "type",
              "category",
              "payload",
              "error_identifier",
              "action"
            ],
            "properties": {
              "time": {
                "description": "",
                "type": "string"
              },
              "type": {
                "description": "",
                "enum": [
                  "DATA ERROR",
                  "SYSTEM ERROR"
                ],
                "type": "string"
              },
              "category": {
                "description": "e.g. Billing, Account, Order, Contact",
                "type": "string"
              },
              "payload": {
                "description": "payload that's being sent to the specific target system",
                "type": "object"
              },
              "error_identifier": {
                "description": "Any Identifier",
                "type": "string"
              },
              "action": {
                "description": "Target system action e.g. create, cancel, update, delete",
                "type": "string"
              }
            }
          }
        }
      },
      "installationShippingRequest": {
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "description": "Unique identifier for the order.",
            "example": "801dx00000YC2M8AAL"
          },
          "subOrderId": {
            "type": "string",
            "description": "Unique identifier for the sub-order.",
            "example": "801dx00000YCwPmAAL"
          },
          "premiseNotes": {
            "type": "string",
            "description": "Notes related to the premise.",
            "example": "Test"
          },
          "customerRequestedStartDate": {
            "type": "string",
            "description": "Requested start date by the customer.",
            "example": "2024-01-16T20:00:00.000+0000"
          },
          "customerRequestedDueDate": {
            "type": "string",
            "description": "Requested due date by the customer.",
            "example": "2024-06-30T19:00:00.000+0000"
          },
          "startBillingBeforeReqDueDate": {
            "type": "string",
            "description": "Indicates if billing should start before the requested due date.",
            "example": "true"
          },
          "contacts": {
            "type": "object",
            "properties": {
              "contactDetails": {
                "type": "object",
                "properties": {
                  "implementationTechnical": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "implementationSiteAccess": {
                    "$ref": "#/components/schemas/orderEnrichmentContactWithPhone"
                  },
                  "implementationSiteAccessAlternate": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "supportSiteAccessPrimary": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "supportSiteAccessAlternate": {
                    "$ref": "#/components/schemas/minimalEmailContact"
                  },
                  "supportTechnicalPrimary": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "supportTechnicalAlternate": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "authorizedContact": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "dayToDayContact": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  },
                  "shipping": {
                    "$ref": "#/components/schemas/orderEnrichmentContact"
                  }
                }
              }
            }
          }
        },
        "required": [
          "orderId",
          "subOrderId",
          "customerRequestedStartDate",
          "customerRequestedDueDate",
          "startBillingBeforeReqDueDate",
          "contacts"
        ]
      },
      "installationShippingResponse": {
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "description": "Unique identifier for the order.",
            "example": "801dx00000Gd00lAAB"
          },
          "subOrderId": {
            "type": "string",
            "description": "Unique identifier for the sub-order.",
            "example": "801dx00000Gd81K"
          },
          "status": {
            "type": "string",
            "description": "Indicates the outcome of the request.",
            "example": "Success"
          },
          "statusMessage": {
            "type": "string",
            "description": "Human-readable message describing the status of the request.",
            "example": "Order Contacts & Installation info is saved"
          }
        }
      },
      "rdsPortReserveRequest": {
        "type": "object",
        "properties": {
          "subOrderId": {
            "type": "string",
            "description": "Unique identifier for the sub-order.",
            "example": "801dx00000WdaKbAAJ"
          },
          "Room": {
            "type": "string",
            "description": "Room number associated with the order.",
            "example": "201"
          },
          "Floor": {
            "type": "string",
            "description": "Floor number associated with the order.",
            "example": "2"
          },
          "Notes": {
            "type": "string",
            "description": "Additional notes provided.",
            "example": "Testing additional notes"
          },
          "TSPCode": {
            "type": "string",
            "description": "Technical Service Provider code.",
            "example": "TSP645321-44"
          }
        },
        "required": [
          "subOrderId",
          "Room",
          "Floor",
          "Notes",
          "TSPCode"
        ]
      },
      "rdsPortReserveResponse": {
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "description": "Unique identifier for the order.",
            "example": "801dx00000Gd00lAAB"
          },
          "status": {
            "type": "string",
            "description": "Indicates the outcome of the request.",
            "example": "Success"
          },
          "statusMessage": {
            "type": "string",
            "description": "Human-readable message describing the status of the request.",
            "example": "Floor & Room info is saved"
          },
          "subOrderId": {
            "type": "string",
            "description": "Unique identifier for the sub-order.",
            "example": "801dx00000Gd81K"
          }
        }
      },
      "newBillingRequest": {
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "description": "Unique identifier for the order.",
            "example": "801dx00000YmDAlAAN"
          },
          "subOrderId": {
            "type": "string",
            "description": "Identifier for the sub-order.",
            "example": "801dx00000Ym90fAAB"
          },
          "description": {
            "type": "string",
            "description": "Additional details or notes about the order.",
            "example": ""
          },
          "paperlessBilling": {
            "type": "string",
            "description": "Indicates whether billing is paperless.",
            "example": ""
          },
          "contacts": {
            "type": "object",
            "properties": {
              "contactDetails": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/billingContact"
                }
              }
            }
          }
        },
        "required": [
          "orderId",
          "subOrderId",
          "description",
          "paperlessBilling",
          "contacts"
        ]
      },
      "newBillingResponse": {
        "type": "object",
        "properties": {
          "billingAccountId": {
            "type": "string",
            "description": "Unique identifier for the billing account.",
            "example": "001dx00000YzuHrAAJ"
          },
          "orderId": {
            "type": "string",
            "description": "Unique identifier for the order.",
            "example": "801dx00000YzoPjAAJ"
          },
          "status": {
            "type": "string",
            "description": "Indicates the outcome of the request.",
            "example": "Billing Account created successfully"
          },
          "subOrderId": {
            "type": "string",
            "description": "Unique identifier for the sub-order.",
            "example": "801dx00000Yzv11AAB"
          }
        }
      },
      "orderApexRequest": {
        "type": "object",
        "properties": {
          "quoteId": {
            "type": "string",
            "description": "Unique identifier for the quote record.",
            "example": "0Q0dx000002Y7ifCAC"
          },
          "checkT&C": {
            "type": "boolean",
            "description": "Boolean flag indicating whether terms and conditions have been checked/validated.",
            "example": true
          },
          "contacts": {
            "type": "object",
            "properties": {
              "contactDetails": {
                "type": "object",
                "properties": {
                  "primary": {
                    "$ref": "#/components/schemas/orderApexContact"
                  },
                  "alternate": {
                    "$ref": "#/components/schemas/orderApexContact"
                  }
                }
              }
            }
          }
        },
        "required": [
          "quoteId",
          "checkT&C",
          "contacts"
        ]
      },
      "orderApexResponse": {
        "type": "object",
        "properties": {
          "orderId": {
            "type": "string",
            "description": "Unique identifier for the overall order.",
            "example": "801dx00000XWPy1AAH"
          },
          "status": {
            "type": "string",
            "description": "Current status of the order.",
            "example": "Success"
          },
          "statusMessage": {
            "type": "string",
            "description": "Additional message describing the status of the order.",
            "example": "Success"
          },
          "subOrder": {
            "type": "object",
            "properties": {
              "subOrderId": {
                "type": "string",
                "description": "Unique identifier for the sub-order.",
                "example": "801dx00000XWdL5AAL"
              },
              "subOrderItem": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/subOrderItem"
                }
              }
            }
          }
        }
      },
      "orderEnrichmentStatusResponse": {
        "type": "object",
        "properties": {
          "Id": {
            "type": "string",
            "description": "Unique identifier of the enrichment record.",
            "example": "802dx00000IfgCTAAZ"
          },
          "CreatedDate": {
            "type": "string",
            "description": "Created date of the enrichment record.",
            "example": "2026-03-05T09:04:51.000+0000"
          },
          "Product2": {
            "type": "string",
            "description": "Product identifier or label.",
            "example": "Product2"
          },
          "Product2.Name": {
            "type": "string",
            "description": "Product name.",
            "example": "Port"
          },
          "Port Speed": {
            "type": "string",
            "description": "Port speed value.",
            "example": "10 Gbps"
          }
        }
      },
      "orderEnrichmentContact": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Specifies the type of contact."
          },
          "firstName": {
            "type": "string",
            "description": "The name of the contact person."
          },
          "lastName": {
            "type": "string",
            "description": "The family or surname of the contact person."
          },
          "email": {
            "type": "string",
            "description": "The email address used to communicate with the contact."
          },
          "street": {
            "type": "string",
            "description": "The street address, including house number and street name."
          },
          "city": {
            "type": "string",
            "description": "The city where the contact resides."
          },
          "state": {
            "type": "string",
            "description": "The state, province, or region of the contact’s address."
          },
          "zip": {
            "type": "string",
            "description": "The postal or ZIP code associated with the contact’s address."
          }
        }
      },
      "orderEnrichmentContactWithPhone": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "street": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "zip": {
            "type": "string"
          }
        }
      },
      "minimalEmailContact": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      },
      "billingContact": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email address of the contact person."
          },
          "type": {
            "type": "string",
            "description": "Role of the contact."
          },
          "firstName": {
            "type": "string",
            "description": "First name of the contact person."
          },
          "lastName": {
            "type": "string",
            "description": "Last name of the contact person."
          },
          "street": {
            "type": "string",
            "description": "Street address of the contact person."
          },
          "city": {
            "type": "string",
            "description": "City where the contact resides."
          },
          "state": {
            "type": "string",
            "description": "State where the contact resides."
          },
          "country": {
            "type": "string",
            "description": "Country code of the contact's address."
          },
          "phone": {
            "type": "string",
            "description": "Phone number of the contact person."
          },
          "zipCode": {
            "type": "string",
            "description": "ZIP/postal code of the contact's address."
          }
        }
      },
      "orderApexContact": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "City where the contact resides."
          },
          "email": {
            "type": "string",
            "description": "Email address of the contact person."
          },
          "firstName": {
            "type": "string",
            "description": "First name of the contact person."
          },
          "lastName": {
            "type": "string",
            "description": "Last name of the contact person."
          },
          "phone": {
            "type": "string",
            "description": "Phone number of the contact person."
          },
          "state": {
            "type": "string",
            "description": "State where the contact resides."
          },
          "street": {
            "type": "string",
            "description": "Street address of the contact person."
          },
          "type": {
            "type": "string",
            "description": "Specifies whether the contact is primary or alternate."
          },
          "zip": {
            "type": "string",
            "description": "ZIP/postal code of the contact's address."
          }
        }
      },
      "subOrderItem": {
        "type": "object",
        "properties": {
          "orderItemId": {
            "type": "string",
            "description": "Unique identifier for each item in the sub-order.",
            "example": "802dx00000Hq16HAAR"
          },
          "orderItemType": {
            "type": "string",
            "description": "Type of the order item.",
            "example": "AT&T Dedicated Internet"
          }
        }
      }
    }
  }
}