{ "info": { "title": "Ordering Mobility", "version": "1.0.0", "description": "Ordering Mobility Placeholder n" }, "tags": [ { "name": "careAccount" }, { "name": "careOrder" }, { "name": "orderCancellation" }, { "name": "orderStatus" }, { "name": "priceQuoteRequest" }, { "name": "storeOrder" }, { "name": "healthCheck" }, { "name": "currentUsageReport" }, { "name": "generateReport" }, { "name": "retrieveReport" }, { "name": "skuAvailability" }, { "name": "wirelessAccountLock" } ], "paths": { "/healthz": { "get": { "tags": [ "healthCheck" ], "summary": "Check if application is up and running", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheck" } } }, "description": "Success" } }, "operationId": "healthCheck", "description": "Check if application is up and running" } }, "/careOrder": { "post": { "tags": [ "careOrder" ], "summary": "Care Order", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "careOrder", "description": "Care order requests are initiated by a client system and sent to AT&T. This transaction is used to update subscriber information such as features, devices, and rate plans.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CareOrderRequest" } } } } } }, "/priceQuote": { "post": { "tags": [ "priceQuoteRequest" ], "summary": "Price Quote", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceQuoteResponse" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "priceQuote", "description": "Price Quote requests are used to verify pricing and check upgrade eligibility.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceQuoteRequest" } } } } } }, "/storeOrder": { "post": { "tags": [ "storeOrder" ], "summary": "Store Order", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "storeOrder", "description": "Store Order requests that can be performed are: New, Upgrade, COAM, LNP, Accessory Only, Upgrade Device Only.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreOrderRequest" } } } } } }, "/careAccount": { "post": { "tags": [ "careAccount" ], "summary": "Care Account", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CareAccountResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "careAccount", "description": "Request Account Details for a CTN, including Device IMEI Number, SIM Card ID, and Rate Plan information.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CareAccountRequest" } } } } } }, "/report/generate": { "post": { "tags": [ "generateReport" ], "summary": "Generate Report", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "generateReport", "description": "Generate a report. Once the report is generated, use the Retrieve Report request to retrieve it.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportRequest" } } } } } }, "/report/retrieve": { "post": { "tags": [ "retrieveReport" ], "summary": "Retrieve Report", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveReportResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "retrieveReport", "description": " Retrieve a report the was generated using the Generate Report Request.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveReportRequest" } } } } } }, "/skuAvailability": { "post": { "tags": [ "skuAvailability" ], "summary": "SKU Availability", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuAvailabilityResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "skuAvailability", "description": "SKU Availability requests check whether a given product or service, identified using a SKU (Stock Keeping Unit), is available for order. Store SKU Availability Request returns a response that shows the availability of the requested SKU.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuAvailabilityRequest" } } } } } }, "/orderCancellation": { "post": { "tags": [ "orderCancellation" ], "summary": "Order Cancellation", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "202": { "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "orderCancellation", "description": "Order Cancellation requests can be used to cancel active orders.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCancellationRequest" } } } } } }, "/report/currentUsage": { "post": { "tags": [ "currentUsageReport" ], "summary": "Current Usage Report", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUsageReportResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "currentUsageReport", "description": "Current Billing Cycle Report of the Estimated Usage for a CTN (Customer Telephone Number).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUsageReportRequest" } } } } } }, "/wirelessAccountLock": { "post": { "tags": [ "wirelessAccountLock" ], "summary": "Wireless Account Lock Request", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WirelessAccountLockResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "wirelessAccountLock", "description": " Used to apply or manage a lock to a specified Billing Account Number (BAN). A lock prevents users from completing a simSwap or portout request transaction. ", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WirelessAccountLockRequest" } } } } } }, "/orderStatus/{orderType}": { "post": { "tags": [ "orderStatus" ], "summary": "Order Status", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1/" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Method Not allowed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server Error" } }, "parameters": [ { "name": "orderType", "required": true, "in": "path", "schema": { "enum": [ "careOrder", "storeOrder" ], "type": "string", "title": "Order Type", "example": "careOrder", "description": "Enumeration of valid order type." } }, { "name": "X-ATT-MessageId", "description": "Unique ID to identify the Request.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Request.", "type": "string" } }, { "name": "Content-Length", "description": "Number of bytes in the Request body.", "required": false, "in": "header", "schema": { "description": "Number of bytes in the Request body.", "default": 0, "type": "integer" } }, { "name": "X-ATT-ConversationId", "description": "Unique ID to identify the Conversation.", "required": true, "in": "header", "schema": { "description": "Unique ID to identify the Conversation.", "type": "string" } }, { "name": "Accept", "description": "Specifies the media type as \"application/json\".", "required": true, "in": "header", "schema": { "description": "Specifies the media type as \"application/json\".", "default": "application/json", "type": "string" } }, { "name": "X-ATT-ClientId", "description": "Client ID used to generate the OAuth bearer token.", "required": false, "in": "header", "schema": { "description": "Client ID used to generate the OAuth bearer token.", "type": "string" } } ], "operationId": "orderStatus", "description": "Order Status requests can be used for the following types of orders: StoreOrder, CareOrder.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusRequest" } } } } } } }, "openapi": "3.0.0", "servers": [ { "url": "https://serverRoot/api/orderingMobility/v1" } ], "components": { "schemas": { "UDL": { "type": "object", "title": "User Defined Label", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "title": "Type", "description": "User Defined Label Type", "example": "User Name" }, "value": { "type": "string", "title": "Value", "description": "User Defined Label Value", "example": "Laura Madison" } } }, "type": { "type": "object", "title": "Device", "required": [ "imei" ], "properties": { "imei": { "type": "string", "example": "359194077165207", "description": "The unique IMEI (Device ID) of the device.\nSpecified when type=updateDevice or type=suspendStolenDeviceWithNetworkBlockedIMEI" }, "iccid": { "type": "string", "example": "89014704272630325832", "description": "The unique ICCID (SIM card ID) of the device." }, "networkBlock": { "type": "string", "example": "True", "description": "If your device has been stolen, \"True\" will suspend your service so no one can activate the device on the AT&T network." } }, "description": "Device" }, "Error": { "type": "object", "required": [ "httpCode", "reason" ], "properties": { "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "httpCode": { "type": "string", "description": "Http Error Code." }, "referenceCode": { "type": "string", "description": "Reference error code." } }, "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).", "x-amf-examples": { "example_2": { "reason": "Method Not allowed", "message": "Example message", "httpCode": "405", "referenceCode": "ERR_B2BI_METHOD_NOT_ALLOWED" }, "example_1": { "reason": "Unauthorized", "message": "Example message", "httpCode": "401", "referenceCode": "ERR_B2BI_INVALID_AUTH" }, "example_0": { "reason": "Bad Request", "message": "Example message", "httpCode": "400", "referenceCode": "ERR_B2BI_BAD_REQUEST" }, "amf_example_1": { "reason": "Forbidden", "message": "Example message", "httpCode": "403", "referenceCode": "ERR_B2BI_API_RESTRICTED" }, "amf_example_2": { "reason": "Not Found", "message": "Example message", "httpCode": "404", "referenceCode": "ERR_B2BI_NOT_FOUND" }, "amf_example_3": { "reason": "Internal Server Error", "message": "Example message", "httpCode": "500", "referenceCode": "ERR_B2BI_SCHEMA" } } }, "items": { "type": "object", "title": "ProductInfo", "required": [ "alaCarte" ], "properties": { "alaCarte": { "$ref": "#/components/schemas/alaCarte" }, "productInfoId": { "type": "string", "title": "ProductInfoId", "description": "Product Info Id" } }, "description": "Product Info" }, "Phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" } } }, "Device": { "type": "object", "properties": { "make": { "type": "string", "example": "APPLE", "description": "The make (manufacturer) of the device." }, "model": { "type": "string", "example": "iPho14A2649", "description": "The model of the device." }, "imei": { "type": "string", "example": "356649016385465", "description": "The unique IMEI (Device ID) of the device." }, "iccid": { "type": "string", "example": "89021807441117437737", "description": "The unique ICCID (SIM card ID) of the device." }, "skuid": { "type": "string", "example": "sku12058500003", "description": "SKU ID" }, "mpn": { "type": "string", "example": "6798D", "description": "The Manufacturer Part Number of the device." } }, "description": "Device" }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/type_4" }, { "$ref": "#/components/schemas/type_5" } ] }, "type_4": { "type": "object", "title": "CareOrderStatus", "properties": { "orderId": { "type": "string", "maxLength": 40, "description": "Order Id", "example": "10-123456789012345" }, "request": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "submitter": { "type": "string" } }, "description": "Request" }, "userType": { "type": "string" }, "orderDate": { "type": "string", "format": "date-time" }, "payloadId": { "type": "string" }, "statusDetail": { "type": "array", "items": { "$ref": "#/components/schemas/StatusDetail" } }, "wirelessUser": { "type": "string" }, "orderContact": { "$ref": "#/components/schemas/OrderContact_1" }, "agreementDate": { "type": "string", "format": "date-time" }, "changeRequest": { "type": "array", "items": { "$ref": "#/components/schemas/items_12" }, "description": "Change Request" }, "wirelessNumber": { "type": "string" }, "installmentPlan": { "$ref": "#/components/schemas/InstallmentPlan" }, "pendingInstallments": { "type": "string" }, "billingAccountNumber": { "type": "string" }, "installmentStartDate": { "type": "string" }, "foundationAccountNumber": { "type": "string" }, "monthlyInstallmentAmount": { "type": "string" } }, "description": "CareOrderStatus" }, "type_5": { "type": "object", "title": "StoreOrderStatus", "properties": { "order": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "type": { "type": "string" } }, "description": "Order" }, "status": { "type": "string" }, "contact": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "email": { "type": "string", "description": "Email", "example": "alexbell@att.com" }, "number": { "type": "string", "description": "Phone" } }, "description": "Contact" }, "taxPrice": { "type": "string" }, "payloadId": { "type": "string", "description": "Payload Id" }, "shippingPrice": { "type": "string", "description": "Shipping Price" }, "trackingNumber": { "type": "string" }, "paymentCardType": { "type": "string", "description": "Payment Card Type" }, "shippingAddress": { "$ref": "#/components/schemas/Shipping" }, "expectedShipDate": { "type": "string", "format": "date-time", "description": "Expected Ship Date" }, "lineOfServiceInfo": { "type": "array", "items": { "$ref": "#/components/schemas/items_13" }, "description": "Line of Service Info" }, "billingAccountNumber": { "type": "string" } }, "description": "StoreOrderStatus" }, "Request": { "type": "object", "properties": { "id": { "type": "string", "example": "al16722109971", "description": "The Request ID" }, "submitter": { "type": "string", "example": "PartnerABC", "description": "The ID of the Request Submitter" }, "type": { "type": "string", "example": "AccountInfo", "description": "The type of request" } }, "description": "Request" }, "Feature": { "type": "object", "required": [ "name", "price" ], "properties": { "name": { "type": "string", "example": "MSECCALLPROTECTCRU" }, "price": { "type": "string", "example": "0.0" }, "skuid": { "type": "string", "example": "sku11860300009" }, "soc": { "type": "string", "example": "SMARTBCRU" }, "effectiveDate": { "type": "string", "format": "date-time", "example": "2024-05-05T13:27:05.000Z" }, "expirationDate": { "type": "string", "format": "date-time", "example": "2025-05-05T13:27:21.678Z" } }, "description": "Feature" }, "OrderId": { "type": "string", "maxLength": 40, "example": "10-123456789012345" }, "items_2": { "type": "object", "title": "ProductInfo", "required": [ "alaCarte" ], "properties": { "alaCarte": { "$ref": "#/components/schemas/alaCarte_6" }, "promotions": { "type": "array", "items": { "$ref": "#/components/schemas/items_7" }, "minItems": 0 }, "totalMonthlyCharges": { "type": "string", "title": "TotalMonthlyCharges", "example": "96.98", "description": "Total Monthly Charges" }, "totalOneTimeCharges": { "type": "string", "title": "TotalOneTimeCharges", "example": "344.99", "description": "Total One Time Charges" } }, "description": "Product Info" }, "Billing": { "type": "object", "title": "BillingDetails", "required": [ "contactName", "phone", "address" ], "properties": { "phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" } }, "description": "Phone" }, "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" }, "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" } }, "description": "Address" }, "contactName": { "type": "object", "title": "Contact Name", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" } }, "description": "Contact Name" }, "attentionTo": { "type": "string", "title": "Attention To", "description": "Attention To", "example": "Jay Watson" }, "addressIndicator": { "type": "boolean", "title": "Address Indicator", "description": "Address Indicator" } } }, "items_3": { "type": "object", "required": [ "id", "action" ], "properties": { "id": { "type": "string", "example": "sku12037300017", "description": "SKU ID of the product" }, "action": { "type": "string", "example": "add", "description": "add or remove a product (Rateplans cannot be removed)" }, "effectiveDate": { "type": "string", "example": "2022-02-15T19:00:00.000-05:00", "description": "SKU Effective Date" }, "expirationDate": { "type": "string", "example": "2023-02-15T19:00:00.000-05:00", "description": "SKU Expiration Date" } }, "description": "Item" }, "items_7": { "type": "object", "title": "Promotions", "required": [ "promotionId", "promotionDescription" ], "properties": { "bundledSKU": { "type": "string", "title": "BundledSKU" }, "promotionId": { "type": "string", "title": "PromotionId", "example": "promo123456789" }, "bundledLine": { "type": "string", "title": "BundledLine" }, "creditedLine": { "type": "boolean", "title": "CreditedLine", "example": true }, "promotionName": { "type": "string", "title": "PromotionName" }, "bundledSKUType": { "type": "string", "title": "BundledSKUType" }, "promotionDescription": { "type": "string", "title": "PromotionDescription", "example": "<p><strong>Limited time; supplies may be limited.</strong></p>\n\n<p><strong>You&rsquo;ll need to:</strong></p>\n\n<ul>\n\t<li>Purchase an iPhone 13 128GB on a qualifying 0% APR installment agreement, including taxes on full retail price (up front) and $35 upgrade fee.</li>\n\t<li>Activate or maintain eligible postpaid AT&amp;T wireless voice-and-data service (min. $70/mo. on AT&amp;T Business Unlimited Standard before discounts; other qual. plans avail.). For plans available to business customers, see https://www.business.att.com/categories/mobile-rate-plans.html. Existing customers can add to eligible current plans. <strong>NOTE: 5G req&rsquo;s compatible plan and device. May not be available in your area. See att.com/5Gforyou for coverage details. For unlimited plans, AT&amp;T may temporarily slow data speeds if the network is busy.</strong></li>\n</ul>\n\n<p><strong>After that you&rsquo;ll get:</strong></p>\n\n<ul>\n\t<li>Up to $558.36 in bill credits on iPhone 13 128GB</li>\n</ul>\n\n<p><strong>Important notes:</strong></p>\n\n<ul>\n\t<li>As long as you have a qualified Business Agreement for Corporate Responsibility User line of service, you can buy on an Equipment Installment Plan (24-mo. at up to $26.25/mo., 30-mo. at up to $21/mo., or 36-mo. at up to $17.50/mo. before credits).</li>\n\t<li>Credits start within 3 bills and will be applied in equal amounts over the term of installment agreement. You will receive catch-up credits once bill credits start.</li>\n\t<li><strong>If you cancel wireless service, your credits will end, and you&rsquo;ll owe the remaining balance on the installment agreement.</strong></li>\n\t<li><strong>$0 down for well-qualified customers only, or down payment may be required and depends on a variety of factors</strong>.</li>\n\t<li><strong>If you choose the optional AT&amp;T Next Up early upgrade feature, you are</strong><strong> responsible and will not receive any credits for an additional $6/mo. for the Next Up upgrade feature</strong>.</li>\n</ul>" } }, "description": "Promotions" }, "SimType": { "enum": [ "eSim", "physicalSim" ], "type": "string", "title": "SIM Type", "description": "Enumeration of valid SIM Types." }, "items_8": { "type": "object", "title": "BillingAccountNumberTransactionExceptionRequest", "required": [ "action", "transaction" ], "properties": { "action": { "enum": [ "ADD", "REMOVE" ], "type": "string", "title": "Action Type", "description": "BillingAccountNumberTransactionException Action: ADD, REMOVE." }, "transaction": { "enum": [ "portout", "simswap", "upgrade" ], "type": "string", "title": "Transaction Type", "description": "Transaction to be added to BAN Transaction exceptionList." } }, "description": "Transaction to be added/removed to exceptionList for a BAN." }, "items_9": { "type": "object", "title": "CTNException Request", "required": [ "action", "ctn" ], "properties": { "ctn": { "type": "string", "description": "CTNException CTN." }, "action": { "enum": [ "ADD", "REMOVE" ], "type": "string", "title": "Action Type", "description": "CTNException Action: ADD, REMOVE." } }, "description": "CTNException Request" }, "Address": { "type": "object", "title": "Address", "required": [ "addressLine1", "city", "state", "zipCode" ], "properties": { "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" }, "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" } } }, "RatePlan": { "type": "object", "properties": { "name": { "type": "string", "example": "Mobile Select Unlimited for Apple Wearables" }, "price": { "type": "string", "example": "25.0" }, "skuid": { "type": "string", "example": "sku11916100003" }, "soc": { "type": "string", "example": "MSULWEARA" }, "effectiveDate": { "type": "string", "format": "date-time", "example": "2024-05-05T18:04:59.821Z" }, "expirationDate": { "type": "string", "format": "date-time", "example": "2025-05-05T18:05:10.467Z" }, "includedFeature": { "type": "array", "items": { "type": "string", "example": "CAN UNLTD CALLING" } } }, "description": "Rate Plan" }, "Shipping": { "type": "object", "title": "ShippingDetails", "required": [ "address", "attentionTo" ], "properties": { "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" }, "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" } }, "description": "Address" }, "carrier": { "type": "string", "title": "Carrier", "description": "Carrier", "example": "FedEx" }, "attentionTo": { "type": "string", "title": "Attention To", "description": "Attention To", "example": "Jay Watson" }, "shippingMethod": { "type": "string", "title": "Shipping Method", "description": "Shipping Method", "example": "FedExGround" }, "addressIndicator": { "type": "boolean", "title": "Address Indicator", "description": "Address Indicator" } } }, "alaCarte": { "type": "object", "title": "AlaCarte (Request)", "properties": { "pdpSku": { "type": "array", "title": "PDPSKU", "items": { "$ref": "#/components/schemas/items_15" }, "maxItems": 16, "minItems": 0, "description": "PDP SKU" }, "addonSku": { "type": "object", "title": "AddonSKU", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" } }, "description": "Addon SKU" }, "deviceSku": { "type": "object", "title": "DeviceSKU", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "installmentPlan": { "$ref": "#/components/schemas/InstallmentPlan" } }, "description": "Device SKU" }, "featureSku": { "type": "array", "title": "FeatureSKU", "items": { "$ref": "#/components/schemas/items_15" }, "minItems": 0, "description": "Feature SKU" }, "ratePlanSku": { "type": "object", "title": "RatePlanSKU", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" } }, "description": "Rate Plan SKU" }, "accessorySku": { "type": "array", "title": "AccessorySKUInfo_Request", "items": { "$ref": "#/components/schemas/items_14" }, "minItems": 0, "description": "Includes the SKU and the quantity requested." } }, "description": "This requests Price Quotes for Device, Rate Plan, Accessories, Features, PDPs, and Add-ons." }, "alacarte": { "type": "object", "properties": { "pdpSku": { "type": "array", "items": { "$ref": "#/components/schemas/items_19" }, "maxItems": 16, "minItems": 0 }, "addonSku": { "type": "object", "title": "Sku", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "description": "SKU ID", "example": "sku284763524" }, "finalAmount": { "type": "string", "description": "Client's max expected amount", "example": "79.95" } }, "description": "Addon SKU" }, "deviceSku": { "type": "object", "title": "Sku", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "description": "SKU ID", "example": "sku284763524" }, "finalAmount": { "type": "string", "description": "Client's max expected amount", "example": "79.95" }, "installmentPlan": { "$ref": "#/components/schemas/installmentPlan" } }, "description": "Device SKU" }, "featureSku": { "type": "array", "items": { "$ref": "#/components/schemas/items_19" }, "maxItems": 100, "minItems": 0, "description": "Feature SKU" }, "ratePlanSku": { "type": "object", "title": "Sku", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "description": "SKU ID", "example": "sku1234567890" }, "finalAmount": { "type": "string", "description": "Client's max expected amount", "example": "70.00" } }, "description": "Rate Plan SKU" }, "accessorySku": { "type": "array", "items": { "$ref": "#/components/schemas/items_18" }, "maxItems": 100, "minItems": 0, "description": "Accessory SKUs" } }, "description": "This requests the purchase of Devices, Rate Plans, Accessories, Features, PDPs, and Add-ons." }, "items_10": { "type": "object", "title": "BillingAccountNumberTransactionExceptionResponse", "required": [ "action", "transaction" ], "properties": { "action": { "enum": [ "ADD", "REMOVE" ], "type": "string", "title": "Action Type", "description": "BillingAccountNumberTransactionException Action." }, "transaction": { "enum": [ "portout", "simswap", "upgrade" ], "type": "string", "title": "Transaction Type", "description": "Transaction to be added to BAN Transaction exceptionList." }, "exceptionStatusDetail": { "$ref": "#/components/schemas/exceptionStatusDetail" } }, "description": "Transaction to be added/removed to exceptionList for a BAN." }, "items_11": { "type": "object", "title": "CTNException", "required": [ "action", "ctn" ], "properties": { "ctn": { "type": "string", "description": "CTNException CTN." }, "action": { "enum": [ "ADD", "REMOVE" ], "type": "string", "title": "Action Type", "description": "CTNException Action: ADD, REMOVE." }, "exceptionStatusDetail": { "$ref": "#/components/schemas/exceptionStatusDetail" } }, "description": "CTNException." }, "items_12": { "type": "object", "properties": { "udl": { "type": "array", "items": { "$ref": "#/components/schemas/UDL" } }, "lineId": { "type": "string" }, "status": { "type": "string" }, "accountInfo": { "type": "string" }, "activateSIM": { "type": "string" }, "cancelReason": { "type": "string" }, "statusDetail": { "type": "array", "items": { "$ref": "#/components/schemas/StatusDetail" } }, "suspendReason": { "type": "string" }, "updateFeature": { "type": "object", "required": [ "totalPriceBeforeDiscounts", "textContent", "requestedEffectiveDate" ], "properties": { "textContent": { "type": "string" }, "featureChangeInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureInfo" } }, "requestedEffectiveDate": { "type": "string" }, "totalPriceBeforeDiscounts": { "type": "string" } }, "description": "Update Feature" }, "changeRatePlan": { "type": "object", "required": [ "totalPriceBeforeDiscounts", "textContent", "requestedRatePlanCost", "requestedEffectiveDate", "requestedRatePlanSKUId" ], "properties": { "newGroupId": { "type": "string" }, "textContent": { "type": "string" }, "currentGroupId": { "type": "string" }, "currentRatePlan": { "type": "string" }, "currentDataPlan": { "type": "string" }, "requestedRatePlan": { "type": "string" }, "requestedDataPlan": { "type": "string" }, "featureChangeInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureInfo" } }, "requestedDataPlanSOC": { "type": "string" }, "requestedRatePlanSOC": { "type": "string" }, "requestedRatePlanCost": { "type": "string" }, "requestedDataPlanSKUId": { "type": "string" }, "requestedEffectiveDate": { "type": "string", "format": "date-time" }, "requestedRatePlanSKUId": { "type": "string" }, "totalPriceBeforeDiscounts": { "type": "string" } }, "description": "Change Rate Plan" }, "wirelessNumber": { "type": "string" }, "updateIMEIDevice": { "type": "object", "required": [ "model", "make" ], "properties": { "make": { "type": "string" }, "model": { "type": "string" } }, "description": "Update IMEI Device" }, "cancelEffectiveDate": { "type": "string", "format": "date-time" }, "updateBillingAccount": { "type": "object", "properties": { "name": { "type": "string" }, "number": { "type": "string" }, "contact": { "type": "object", "properties": { "phone": { "$ref": "#/components/schemas/Phone" }, "address": { "$ref": "#/components/schemas/Address" }, "fullName": { "type": "string" } }, "description": "Billing Account Contact" }, "address": { "$ref": "#/components/schemas/Address" } }, "description": "Billing Account" }, "updateIMEIDeviceMake": { "type": "string" }, "updateSubscriberAddress": { "$ref": "#/components/schemas/Address" }, "changeRatePlanWithDevice": { "type": "object", "required": [ "updateDevice", "changeRatePlan" ], "properties": { "updateDevice": { "type": "object", "required": [ "model", "make" ], "properties": { "make": { "type": "string" }, "model": { "type": "string" } }, "description": "Update Device" }, "changeRatePlan": { "type": "object", "required": [ "totalPriceBeforeDiscounts", "textContent", "requestedRatePlanCost", "requestedEffectiveDate", "requestedRatePlanSKUId" ], "properties": { "newGroupId": { "type": "string" }, "textContent": { "type": "string" }, "currentGroupId": { "type": "string" }, "currentRatePlan": { "type": "string" }, "currentDataPlan": { "type": "string" }, "requestedRatePlan": { "type": "string" }, "requestedDataPlan": { "type": "string" }, "featureChangeInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureInfo" } }, "requestedDataPlanSOC": { "type": "string" }, "requestedRatePlanSOC": { "type": "string" }, "requestedRatePlanCost": { "type": "string" }, "requestedDataPlanSKUId": { "type": "string" }, "requestedEffectiveDate": { "type": "string", "format": "date-time" }, "requestedRatePlanSKUId": { "type": "string" }, "totalPriceBeforeDiscounts": { "type": "string" } }, "description": "Change Rate Plan" } }, "description": "Change Rate Plan with Device" }, "updateFeaturesWithDevice": { "type": "object", "required": [ "updateFeature", "updateDevice" ], "properties": { "updateDevice": { "type": "object", "required": [ "model", "make" ], "properties": { "make": { "type": "string" }, "model": { "type": "string" } }, "description": "Update Device" }, "updateFeature": { "type": "object", "required": [ "totalPriceBeforeDiscounts", "textContent", "requestedEffectiveDate" ], "properties": { "textContent": { "type": "string" }, "featureChangeInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureInfo" } }, "requestedEffectiveDate": { "type": "string" }, "totalPriceBeforeDiscounts": { "type": "string" } }, "description": "Update Feature" } }, "description": "Update Feature with Device" } } }, "items_13": { "type": "object", "required": [ "udl" ], "properties": { "ctn": { "type": "string" }, "lnp": { "$ref": "#/components/schemas/LNPAccount" }, "udl": { "type": "array", "items": { "$ref": "#/components/schemas/UDL" } }, "type": { "type": "string" }, "device": { "type": "object", "properties": { "mpn": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "string" }, "skuId": { "type": "string" }, "status": { "type": "string" }, "simICCID": { "type": "string" }, "quantity": { "type": "string" }, "imeiNumber": { "type": "string" }, "installmentPlan": { "$ref": "#/components/schemas/InstallmentPlan" }, "shipmentCommitDate": { "$ref": "#/components/schemas/ShipmentCommitDate" }, "monthlyInstallmentAmount": { "type": "string" } }, "description": "Device SKU" }, "lineId": { "type": "string" }, "status": { "type": "string" }, "coamIMEI": { "type": "string" }, "dataPlan": { "type": "object", "properties": { "soc": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "string" }, "skuId": { "type": "string" } }, "description": "Data Plan" }, "ratePlan": { "type": "object", "properties": { "soc": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "string" }, "skuId": { "type": "string" }, "upgradeFee": { "type": "string" }, "contractTerm": { "type": "string" }, "activaitionFee": { "type": "string" } }, "description": "Rate Plan" }, "coamICCId": { "type": "string" }, "existingCTN": { "type": "string" }, "featureInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureInfo" } }, "statusDetail": { "type": "array", "items": { "$ref": "#/components/schemas/StatusDetail" } }, "accessoryInfo": { "type": "array", "items": { "$ref": "#/components/schemas/items_20" } }, "monthlyCharge": { "type": "string" }, "oneTimeCharge": { "type": "string" }, "subscriberName": { "type": "string" }, "existingBusinessAccountNumber": { "type": "string" }, "existingFoundationAccountNumber": { "type": "string" } } }, "items_14": { "type": "object", "title": "AccessorySKUInfo (Request)", "required": [ "skuId", "quantity" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "quantity": { "type": "integer", "title": "Quantity", "default": 0, "example": 1, "description": "Quantity of Accessory" } }, "description": "Accessory SKU Info" }, "items_15": { "type": "object", "title": "SKUId", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" } }, "description": "SKU ID" }, "items_16": { "type": "object", "title": "AccessorySKUInfo (Response)", "required": [ "shipmentCommitDays", "skuId", "quantity" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "quantity": { "type": "integer", "title": "Quantity", "example": 1, "description": "Accessory Quantity" }, "priceType": { "enum": [ "MRC", "NRC" ], "type": "string", "title": "PriceType", "example": "NRC", "description": "Price Type" }, "listPrice": { "type": "string", "title": "ListPrice", "example": "839.99", "description": "List Price" }, "finalAmount": { "type": "string", "title": "FinalAmount", "example": "299.99", "description": "Final Amount" }, "totalAdjustment": { "type": "string", "title": "TotalAdjustment", "example": "540", "description": "Total Adjustment" }, "shipmentCommitDays": { "$ref": "#/components/schemas/ShipmentCommitDays" } }, "description": "Accessory SKU Info" }, "items_17": { "type": "object", "title": "SkuInfo_Common", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "priceType": { "enum": [ "MRC", "NRC" ], "type": "string", "title": "PriceType", "example": "NRC", "description": "Price Type" }, "listPrice": { "type": "string", "title": "ListPrice", "example": "839.99", "description": "List Price" }, "finalAmount": { "type": "string", "title": "FinalAmount", "example": "299.99", "description": "Final Amount" }, "totalAdjustment": { "type": "string", "title": "Total Adjustment", "example": "540", "description": "Total Adjustment" } }, "description": "SKU details and current pricing." }, "items_18": { "type": "object", "required": [ "skuId", "quantity" ], "properties": { "skuId": { "type": "string", "description": "SKU ID", "example": "sku284763524" }, "quantity": { "type": "integer", "default": 1, "description": "Quantity of the Accessory ordered", "example": 1 }, "finalAmount": { "type": "string", "description": "Client's max expected amount", "example": "79.95" } }, "description": "Accessory details contains SKU ID and Quantity of Accessory ordered." }, "items_19": { "type": "object", "title": "Sku", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "description": "SKU ID", "example": "sku284763524" }, "finalAmount": { "type": "string", "description": "Client's max expected amount", "example": "79.95" } }, "description": "SKUs" }, "items_20": { "type": "object", "required": [ "name", "price", "quantity", "skuId" ], "properties": { "mpn": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "string" }, "skuId": { "type": "string" }, "quantity": { "type": "string" }, "shipmentCommitDate": { "$ref": "#/components/schemas/ShipmentCommitDate" } } }, "RangeDate": { "type": "object", "title": "Range Date", "required": [ "startDate", "endDate" ], "properties": { "startDate": { "type": "string", "title": "Start Date", "description": "Start Date", "example": "MM/DD/YYYY" }, "endDate": { "type": "string", "title": "End Date", "description": "End Date", "example": "MM/DD/YYYY" } } }, "alaCarte_6": { "type": "object", "title": "AlaCarte (Response)", "properties": { "pdpSku": { "type": "array", "title": "PDPSKU", "items": { "$ref": "#/components/schemas/items_17" }, "maxItems": 16, "minItems": 0, "description": "PDP SKU" }, "addonSku": { "type": "object", "title": "AddonSKU", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "priceType": { "enum": [ "MRC", "NRC" ], "type": "string", "title": "PriceType", "example": "NRC", "description": "Price Type" }, "listPrice": { "type": "string", "title": "ListPrice", "example": "839.99", "description": "List Price" }, "finalAmount": { "type": "string", "title": "FinalAmount", "example": "299.99", "description": "Final Amount" }, "totalAdjustment": { "type": "string", "title": "TotalAdjustment", "example": "540", "description": "Total Adjustment" } }, "description": "Addon SKU" }, "deviceSku": { "type": "object", "title": "DeviceSKU", "required": [ "calculatedPriceListType", "shipmentCommitDays", "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "priceType": { "enum": [ "MRC", "NRC" ], "type": "string", "title": "PriceType", "example": "NRC", "description": "Price Type" }, "listPrice": { "type": "string", "title": "ListPrice", "example": "839.99", "description": "List Price" }, "finalAmount": { "type": "string", "title": "FinalAmount", "example": "299.99", "description": "Final Amount" }, "totalAdjustment": { "type": "string", "title": "TotalAdjustment", "example": "540", "description": "Total Adjustment" }, "installmentPlan": { "$ref": "#/components/schemas/InstallmentPlan" }, "shipmentCommitDays": { "$ref": "#/components/schemas/ShipmentCommitDays" }, "calculatedPriceListType": { "type": "string", "title": "CalculatedPriceListType", "example": "Standard Contracted Price", "description": "Calculated Price List Type" } }, "description": "Device SKU" }, "featureSku": { "type": "array", "title": "FeatureSKU", "items": { "$ref": "#/components/schemas/items_17" }, "minItems": 0, "description": "Feature SKU" }, "ratePlanSku": { "type": "object", "title": "RatePlanSKU", "required": [ "skuId" ], "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "priceType": { "enum": [ "MRC", "NRC" ], "type": "string", "title": "PriceType", "example": "NRC", "description": "Price Type" }, "listPrice": { "type": "string", "title": "ListPrice", "example": "839.99", "description": "List Price" }, "finalAmount": { "type": "string", "title": "FinalAmount", "example": "299.99", "description": "Final Amount" }, "totalAdjustment": { "type": "string", "title": "TotalAdjustment", "example": "540", "description": "Total Adjustment" } }, "description": "Rate Plan SKU" }, "accessorySku": { "type": "array", "title": "AccessorySKUInfo_Response", "items": { "$ref": "#/components/schemas/items_16" }, "minItems": 0, "description": "Includes the SKU and the quantity requested." } }, "description": "This shows Price Quotes for Device, Rate Plan, Accessories, Features, PDPs, and Add-ons." }, "LNPAccount": { "type": "object", "title": "LNPAccount", "required": [ "numberToPort", "accountNumber", "contactName", "address", "accountHolder" ], "properties": { "phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number (10 digit)" } }, "description": "Phone" }, "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code (5 digit)" }, "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" } }, "description": "Address" }, "passwordPin": { "type": "string", "title": "Password Pin", "description": "Password Pin", "example": "1231" }, "contactName": { "type": "object", "title": "ContactNameWithMiddleName", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" }, "middleName": { "type": "string", "title": "Middle Name", "description": "Middle Name", "example": "Graham" } }, "description": "Contact Name" }, "numberToPort": { "type": "string", "title": "Number To Port", "description": "Number To Port", "example": "2125551212" }, "accountNumber": { "type": "string", "title": "Account Number", "description": "Account Number", "example": "123123456" }, "accountHolder": { "type": "object", "title": "AccountHolder", "required": [ "businessAccount" ], "properties": { "taxId": { "type": "string", "title": "Tax Id", "description": "Tax Id", "example": "23-4567890" }, "businessAccount": { "type": "object", "title": "BusinessAccount", "required": [ "name", "authorizer" ], "properties": { "name": { "type": "string", "title": "Business Name", "description": "Business Name", "example": "Newco Inc" }, "authorizer": { "type": "string", "title": "Authorizer", "description": "Authorizer", "example": "Amy Hill" } }, "description": "Business Account" } }, "description": "Account Holder" } } }, "Subscriber": { "type": "object", "title": "SubscriberDetails", "required": [ "contactName", "address" ], "properties": { "phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" }, "extension": { "type": "string", "title": "Phone Extension", "description": "Phone Extension", "example": "1885" } }, "description": "Phone" }, "email": { "type": "string", "title": "Email", "description": "Email", "example": "alexbell@att.com" }, "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" }, "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" } }, "description": "Address" }, "contactName": { "type": "object", "title": "Contact Name", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" } }, "description": "Contact Name" }, "attentionTo": { "type": "string", "title": "Attention To", "description": "Attention To", "example": "Jay Watson" } } }, "HealthCheck": { "type": "object", "title": "HealthCheck", "required": [ "application_name", "message", "time" ], "properties": { "time": { "type": "string", "format": "date-time", "description": "Date the request was received by the server" }, "message": { "type": "string", "description": "Status of the application" }, "application_name": { "type": "string", "description": "Name of the application" } } }, "ContactName": { "type": "object", "title": "Contact Name", "required": [ "firstName", "lastName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" } } }, "FeatureInfo": { "type": "object", "title": "Feature Info", "required": [ "action", "feature", "featureCost", "featureName", "skuId" ], "properties": { "soc": { "type": "string", "title": "SOC", "description": "SOC" }, "skuId": { "type": "string", "title": "SKUId", "description": "SKU ID" }, "action": { "type": "string", "title": "Action", "description": "Action" }, "feature": { "type": "string", "title": "Feature", "description": "Feature" }, "featureCost": { "type": "string", "title": "Feature Cost", "description": "Feature Cost" }, "featureName": { "type": "string", "title": "Feature Name", "description": "Feature Name" }, "effectiveDate": { "type": "string", "title": "Effective Date", "description": "Effective Date" }, "expirationDate": { "type": "string", "title": "Expiration Date", "description": "Expiration Date" } } }, "OrderContact": { "type": "object", "required": [ "contact", "phone", "email" ], "properties": { "contact": { "$ref": "#/components/schemas/ContactName" }, "phone": { "$ref": "#/components/schemas/PhoneWithExtension" }, "email": { "type": "string", "title": "Email", "description": "Email", "example": "alexbell@att.com" } }, "description": "Order Contact Information" }, "CancelOrders": { "type": "object", "required": [ "orderId" ], "properties": { "orderId": { "type": "string", "description": "Order Id.", "example": "10-123456789012345" } }, "description": "CancelOrders." }, "StatusDetail": { "type": "object", "title": "Status Detail", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "title": "Name", "description": "Name" }, "value": { "type": "string", "title": "Value", "description": "Value" } } }, "AccessOptions": { "type": "object", "required": [ "isDefault", "name", "price", "type" ], "properties": { "isDefault": { "type": "string", "example": "true" }, "name": { "type": "string", "example": "ENHANCEDPHONE" }, "price": { "type": "string", "example": "0.0" }, "type": { "type": "string", "example": "STATIC" } }, "description": "Access Options" }, "ChangeRequest": { "type": "object", "required": [ "type", "changeRequestId", "ctn" ], "properties": { "type": { "$ref": "#/components/schemas/ChangeRequestType" }, "changeRequestId": { "type": "string", "example": "ChangeID1", "description": "Unique ID for the Change Request" }, "effectiveDate": { "type": "string", "example": "nextBillingCycle", "description": "When the new Rate Plan will take effect.\nValid values are \"nextBillingCycle\", \"uponCompletionOfRequest\", or a Date in \"mm/dd/yyyy\" format.\nRequired when Change Request Type is \"changeRatePlan\" or \"changeRatePlanWithDeviceUpdate\"." }, "ctn": { "type": "string", "example": "1234567890", "description": "Customer Telephone Number (10 digit)" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/items_3" } }, "udl": { "type": "array", "items": { "$ref": "#/components/schemas/UDL" }, "maxItems": 4 }, "suspendServiceReason": { "type": "string", "example": "Lost", "description": "Reason to suspend Customer Telephone Number.\nValid values [Lost, Stolen, Vacation]\nPopulated only when Type = \"suspendService\"" }, "resumeServiceReason": { "type": "string", "example": "CustomerRequest", "description": "Reason for resuming service.\nSpecify when type=resumeFromCancel" }, "cancellationReason": { "type": "string", "example": "CorporateCustomerCancel", "description": "Reason to cancel customer phone number.\nSpecify when type=\"cancelService\"\nValid values: [CorporateCustomerCancel, AccountHolderdeath, MilitaryPersonnel,\nTransferNumberToOtherCarrier, LostOrStolenDevices, $0MonthlyServiceFeePlans\n" }, "cancelServiceReason": { "type": "string", "example": "EmployeeLeftCompany", "description": "Reason for cancelling service.\nSpecify when type=cancelService\nValid values: [Billing, EmployeeLeftCompany]" }, "cancelEffectiveDate": { "type": "string", "example": "immediate", "description": "Specifies when the service will be cancelled.\nSpecify when type=cancelService\nValid values: [immediate, endOfBillCycle]" }, "replaceDuplicateFeatures": { "type": "boolean", "example": true, "description": "Indicator used in bulk features flow to control duplicate features (i.e. features belonging to same category)" }, "replaceConflictingFeatures": { "type": "boolean", "example": true, "description": "Indicator used to allow conflicting features to be replaced by new features for the CTN" }, "resetVoiceMail": { "type": "object", "title": "Reset Voice Mail PIN", "properties": { "pin": { "title": "Pin", "description": "4 digit PIN", "example": "1234", "type": "string", "pattern": "^\\d{4}$", "minLength": 4, "maxLength": 4 }, "autogeneratedPin": { "title": "AutogeneratedPin", "description": "AutogeneratedPin", "example": true, "type": "boolean", "default": true } }, "description": "Reset Voice Mail PIN using 1 of the 2 schemas, but not both.\nSpecified when type=voicemailPasswordReset" }, "billingContact": { "type": "object", "title": "BillingDetails", "required": [ "address", "phone", "contactName" ], "properties": { "contactName": { "type": "object", "title": "Contact Name", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" } }, "description": "Contact Name" }, "attentionTo": { "type": "string", "title": "Attention To", "description": "Attention To", "example": "Jay Watson" }, "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" }, "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" } }, "description": "Address" }, "addressIndicator": { "type": "boolean", "title": "Address Indicator", "description": "Address Indicator" }, "phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" } }, "description": "Phone" } }, "description": "Billing Contact" }, "subscriberContact": { "type": "object", "title": "SubscriberContact", "required": [ "name", "address", "phone" ], "properties": { "name": { "type": "object", "title": "Contact Name", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" } }, "description": "Contact Name" }, "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" }, "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" } }, "description": "Address" }, "phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" } }, "description": "Phone" } }, "description": "Subscriber contact information" }, "device": { "$ref": "#/components/schemas/type" } }, "description": "Change Request" }, "BillingContact": { "type": "object", "title": "BillingContact", "properties": { "name": { "type": "string", "example": "Alex Bell", "description": "Name (person or business) of the billing contact." }, "attentionTo": { "type": "string", "example": "\"Alex Bell\" or \"Billing Dept.\"", "description": "Intended recipient, such as a person or area of a business." }, "addressLine": { "type": "string", "example": "109 Court Street", "description": "Street address of the billing contact." }, "city": { "type": "string", "example": "Boston", "description": "City of the Billing Contact" }, "state": { "type": "string", "example": "MA", "description": "State of the Billing Contact" }, "zipCode": { "type": "string", "example": "02114", "description": "Zip Code of the Billing Contact." }, "phoneNumber": { "type": "string", "example": "1234567890", "pattern": "^\\d{10}$" }, "email": { "type": "string", "example": "agbell@att.com", "description": "Email address of the Billing Contact" } }, "description": "Billing Contact" }, "OrderContact_1": { "type": "object", "title": "OrderContact", "required": [ "contactName", "phone", "email" ], "properties": { "phone": { "type": "object", "title": "Phone", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" }, "extension": { "type": "string", "title": "Phone Extension", "description": "Phone Extension", "example": "1885" } }, "description": "Phone" }, "email": { "type": "string", "title": "Email", "example": "abell@att.com", "description": "Email" }, "contactName": { "type": "object", "title": "Contact Name", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" } }, "description": "Contact Name" } } }, "LinesOfService": { "type": "object", "required": [ "lineOfServiceId", "serviceZipCode", "type" ], "properties": { "billingAccountNumber": { "type": "string", "pattern": "^[0-9]{8,9}([0-9]{4})?$", "description": "Billing Account Number.", "example": "123454329" }, "coamIMEI": { "type": "string", "maxLength": 15, "description": "The mobile device’s unique 15-digit identifier", "example": "123456789012345" }, "coamICCID": { "type": "string", "description": "The unique identifier of the mobile device’s SIM card (or eSIM)", "example": "89012345678901234567" }, "ctn": { "type": "string", "pattern": "^\\d{10}$", "description": "Customer Telephone Number (10 digit)", "example": "2234567890" }, "foundationAccountNumber": { "type": "string", "minLength": 4, "maxLength": 8, "description": "A unique number to group a customer account across all markets. (Note: Add leading zero(s) to create an 8 digit number.)", "example": "00345678" }, "installmentPlanId": { "type": "string", "description": "Installment Plan Id", "example": "EIP36" }, "lineOfServiceId": { "type": "string", "description": "Line of Service Id", "example": "1" }, "lnpDetail": { "$ref": "#/components/schemas/LNPAccount" }, "mobileSharePlan": { "type": "object", "title": "Mobile Share Plan", "properties": { "isPrimary": { "type": "boolean", "description": "Primary flag", "example": false }, "primaryLineId": { "type": "string", "description": "Primary Line Id", "example": "13579" }, "existingGroupId": { "type": "string", "description": "Existing Group Id", "example": "24680" } }, "description": "Mobile Share Plan" }, "npaPreferredAreaCode": { "type": "string", "description": "(Numbering Plan Area) Preferred Area Code", "example": "617" }, "npaServiceAreaName": { "type": "string", "description": "(Numbering Plan Area) Service Area Name", "example": "Boston Metro Area" }, "npaServiceArea": { "type": "string", "description": "(Numbering Plan Area) Service Area", "example": "Boston" }, "optInForTradeIn": { "type": "boolean", "description": "Opt In for Trade-in.", "example": true }, "productInfo": { "type": "object", "title": "Product Info", "properties": { "network": { "type": "string", "description": "Network Type", "example": "FirstNet" }, "simType": { "$ref": "#/components/schemas/SimType" }, "alacarte": { "$ref": "#/components/schemas/alacarte" } }, "description": "Product Info" }, "serviceZipCode": { "type": "string", "example": "75201", "pattern": "^\\d{5}$", "description": "Service Zip Code (5 digit)" }, "subscriber": { "$ref": "#/components/schemas/Subscriber" }, "subLevelIdentifier": { "type": "string", "description": "Sub Level Identifier", "example": "EMS" }, "type": { "$ref": "#/components/schemas/LineOfServiceType" }, "udl": { "type": "array", "items": { "$ref": "#/components/schemas/UDL" }, "maxItems": 4, "minItems": 0 }, "upgradeWaiverEligible": { "type": "boolean", "description": "Upgrade Waiver Eligible" } }, "description": "Lines Of Service" }, "InstallmentPlan": { "type": "object", "properties": { "contractType": { "type": "string", "title": "ContractType", "example": "EIP", "description": "Contract Type" }, "installmentPlanId": { "type": "string", "example": "EIP24", "description": "Installment Plan Id" }, "contractTermLength": { "type": "string", "title": "ContractTermLength", "example": "24", "description": "Contract Term Length" } }, "description": "Installment Plan" }, "installmentPlan": { "type": "object", "properties": { "installmentPlanId": { "type": "string", "example": "EIP24", "description": "Installment Plan Id" }, "contractType": { "type": "string", "title": "ContractType", "example": "EIP", "description": "Contract Type" }, "contractTermLength": { "type": "string", "title": "ContractTermLength", "example": "24", "description": "Contract Term Length" }, "downPayment": { "type": "string", "title": "Down Payment", "example": "333.33", "description": "Down Payment" } }, "description": "Installment Plan." }, "CareOrderRequest": { "type": "object", "required": [ "careOrderRequest" ], "properties": { "careOrderRequest": { "type": "object", "required": [ "accountGroupId", "changeRequest" ], "properties": { "foundationAccountNumber": { "type": "string", "example": "81730304", "description": "Foundation Account Number to bill to. (Note: Add leading zero(s) to create an 8 digit number.)" }, "accountGroupId": { "type": "string", "example": "73001012763", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group of the user" }, "poNumber": { "type": "string", "example": "202405040001", "description": "Purchase Order number" }, "consentToRecurringCharges": { "type": "boolean", "example": true, "description": "Recurring Charges Acceptance." }, "orderContact": { "$ref": "#/components/schemas/OrderContact" }, "changeRequest": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } } } } } }, "CreditCardDetail": { "type": "object", "title": "CreditCardDetails", "required": [ "creditCard", "contactName", "address", "paymentType" ], "properties": { "address": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" }, "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" } }, "description": "address" }, "consent": { "type": "object", "title": "Consent", "required": [ "tncKey", "tncId" ], "properties": { "tncId": { "type": "integer", "title": "TNC Id", "description": "TNC Id" }, "tncKey": { "type": "string", "title": "TNC Key", "maxLength": 20, "description": "TNC Key" } }, "description": "Consent" }, "creditCard": { "type": "object", "title": "Credit Card", "required": [ "securityCode", "number", "expirationYear", "expirationMonth", "type" ], "properties": { "type": { "type": "string", "title": "Credit Card Type", "example": "Visa", "description": "Credit Card Type" }, "number": { "type": "string", "title": "Credit Card Number", "example": "1234567812345678", "description": "Credit Card Number" }, "securityCode": { "type": "string", "title": "Security Code", "example": "752", "description": "Security Code" }, "expirationYear": { "type": "string", "title": "Expiration Year", "example": "2030", "description": "Expiration Year" }, "expirationMonth": { "type": "string", "title": "Expiration Month", "example": "01", "description": "Expiration Month" } }, "description": "Credit Card Info" }, "contactName": { "type": "object", "title": "ContactNameWithMiddleInitial", "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "title": "Last Name", "example": "Bell", "description": "Last Name" }, "firstName": { "type": "string", "title": "First Name", "example": "Alex", "description": "First Name" }, "middleInitial": { "type": "string", "title": "Middle Initial", "description": "Middle Initial", "example": "G" } }, "description": "Contact Name" }, "paymentType": { "enum": [ "ONETIME", "RECURRING" ], "type": "string", "title": "Payment Type", "description": "Payment Type" }, "prepopCreditCardIndicator": { "type": "boolean", "title": "Prepop CreditCard Indicator", "description": "Prepop CreditCard Indicator" } } }, "PriceQuoteRequest": { "type": "object", "title": "PriceQuoteRequest", "required": [ "priceQuoteRequest" ], "properties": { "priceQuoteRequest": { "type": "object", "required": [ "accountGroupId", "serviceZipCode", "type", "productInfo" ], "properties": { "accountGroupId": { "type": "string", "title": "AccountGroupId", "example": "a98765432109", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account group you are requesting pricing details for." }, "ctn": { "type": "string", "title": "CTN", "example": "5555055525", "pattern": "^\\d{10}$", "description": "10-digit wireless number you want upgrade pricing for. Required if 'Type' is set to 'Upgrade'." }, "foundationAccountNumber": { "type": "string", "title": "FoundationAccountNumber", "minLength": 4, "maxLength": 8, "description": "A unique number to group a customer account across all markets. (Note: Add leading zero(s) to create an 8 digit number.)", "example": "12345678" }, "serviceZipCode": { "type": "string", "title": "ServiceZipCode", "example": "75202", "pattern": "^\\d{5}$", "description": "Service Zip Code in 5-digit format." }, "type": { "enum": [ "New", "LNP", "COAM", "Upgrade" ], "type": "string", "title": "Type", "example": "New", "description": "Service Type" }, "productInfo": { "type": "array", "title": "ProductInfo", "items": { "$ref": "#/components/schemas/items" }, "maxItems": 100, "minItems": 1, "description": "Products to request Price Quotes for" } } } }, "description": "PriceQuote Request" }, "StoreOrderRequest": { "type": "object", "required": [ "storeOrderRequest" ], "properties": { "storeOrderRequest": { "type": "object", "required": [ "accountGroupId" ], "properties": { "accountGroupId": { "type": "string", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account group of the user.", "example": "a98765432109" }, "federalTaxId": { "type": "string", "description": "Federal Tax Id", "example": "12-3456789" }, "groupControlNumber": { "type": "string", "description": "Group Control Number", "example": "1122334455" }, "poNumber": { "type": "string", "description": "Purchase Order Number.", "example": "PO-12345" }, "oneTimePaymentOption": { "type": "string", "description": "One Time Payment Option", "example": "Bill" }, "recurringPaymentOption": { "type": "string", "description": "Recurring Payment Option", "example": "Bill" }, "installmentAgreementAcceptance": { "type": "boolean", "description": "Installment Agreement Acceptance", "example": true }, "consentToRecurringCharges": { "type": "boolean", "description": "Recurring Charges Acceptance", "example": true }, "linesOfService": { "type": "array", "items": { "$ref": "#/components/schemas/LinesOfService" }, "maxItems": 100, "minItems": 1 }, "billing": { "$ref": "#/components/schemas/Billing" }, "creditCardDetail": { "type": "array", "items": { "$ref": "#/components/schemas/CreditCardDetail" }, "maxItems": 2, "minItems": 0 }, "orderContact": { "$ref": "#/components/schemas/OrderContact_1" }, "shipping": { "$ref": "#/components/schemas/Shipping" } } } } }, "ChangeRequestType": { "enum": [ "updateSubscriber", "changeRatePlan", "updateFeatures", "suspendService", "reinstateService", "changeCTN", "updateDevice", "changeGroupRatePlan", "activateSim", "voicemailPasswordReset", "cancelService", "resumeFromCancel", "changeRatePlanWithDeviceUpdate", "updateFeaturesWithDeviceUpdate" ], "type": "string", "title": "Change Request Type", "description": "Enumeration of valid Change Request Type." }, "LineOfServiceType": { "enum": [ "New", "Upgrade", "COAM", "Accessory Only", "LNP", "Upgrade Device Only" ], "type": "string", "title": "Line of Service Type", "description": "Enumeration of valid Line of Service Types." }, "CareAccountRequest": { "type": "object", "required": [ "careAccountRequest" ], "properties": { "careAccountRequest": { "type": "object", "required": [ "accountGroupId", "ctn" ], "properties": { "accountGroupId": { "type": "string", "example": "73001012763", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group of the user" }, "ctn": { "type": "string", "example": "1234567890", "pattern": "^\\d{10}$", "minLength": 10, "maxLength": 10, "description": "Customer Telephone Number (10 digit)" } } } } }, "OrderStatusRequest": { "type": "object", "required": [ "orderStatusRequest" ], "properties": { "orderStatusRequest": { "type": "object", "required": [ "accountGroupId" ], "properties": { "orderId": { "$ref": "#/components/schemas/OrderId" }, "rangeDate": { "$ref": "#/components/schemas/RangeDate" }, "accountGroupId": { "type": "string", "example": "73001012763", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group of the user" }, "offlineOrderPayloadId": { "type": "string", "example": "12345678901234567890_pld" } } } } }, "PriceQuoteResponse": { "type": "object", "title": "PriceQuoteResponse", "required": [ "priceQuoteResponse" ], "properties": { "priceQuoteResponse": { "type": "object", "properties": { "productInfo": { "type": "array", "title": "ProductInfo", "items": { "$ref": "#/components/schemas/items_2" }, "description": "Price Quotes for the products requested with related details and current promotions." } } } }, "description": "PriceQuote Response" }, "PhoneWithExtension": { "type": "object", "title": "PhoneWithExtension", "required": [ "number" ], "properties": { "number": { "type": "string", "title": "Phone Number", "example": "1234567890", "description": "Phone Number" }, "extension": { "type": "string", "title": "Phone Extension", "description": "Phone Extension", "example": "1885" } } }, "ShipmentCommitDays": { "type": "object", "title": "ShipmentCommitDays", "required": [ "fromDays", "toDays" ], "properties": { "fromDays": { "type": "integer", "title": "FromDays", "default": 0, "example": 3, "description": "Minimum number of days expected to be shipped in" }, "toDays": { "type": "integer", "title": "ToDays", "default": 0, "example": 5, "description": "Maximum number of days expected to be shipped in" } }, "description": "Range of days expected to be shipped within." }, "ShipmentCommitDate": { "type": "object", "title": "Shipment Commit Date", "required": [ "fromDate", "toDate" ], "properties": { "toDate": { "type": "string", "title": "To Date", "description": "To Date - Shipment Commit end date" }, "fromDate": { "type": "string", "title": "From Date", "description": "From Date - Shipment Commit start date" } }, "description": "ShipmentCommitDate - Range of dates expected to be in shipment" }, "CareAccountResponse": { "type": "object", "required": [ "careAccountResponse" ], "properties": { "careAccountResponse": { "type": "object", "required": [ "billingAccountName", "billingAccountNumber", "billingContact" ], "properties": { "payloadId": { "type": "string", "example": "1234567820240502174342_PayLId", "description": "Unique Transaction ID" }, "request": { "$ref": "#/components/schemas/Request" }, "foundationAccountName": { "type": "string", "example": "PartnerBCD1FAN", "description": "The Name of the Foundation Account." }, "foundationAccountNumber": { "type": "string", "example": "05571312", "description": "A unique number to group a customer account across all markets." }, "billingAccountName": { "type": "string" }, "billingAccountNumber": { "type": "string", "example": "123456789012" }, "billingContact": { "$ref": "#/components/schemas/BillingContact" }, "wirelessUserName": { "type": "string", "example": "Alexander Bell" }, "wirelessUserNumber": { "type": "string", "example": "1234567890", "pattern": "^\\d{10}$", "description": "The user\\'s Wireless Number (CTN)" }, "discount": { "type": "string", "example": "25.0" }, "contractStartDate": { "type": "string", "format": "date-time", "example": "2022-10-18T20:00:00.000-04:00", "description": "The Date the contract starts" }, "contractEndDate": { "type": "string", "format": "date-time", "example": "2024-10-18T20:00:00.000-04:00", "description": "The Date the contract ends" }, "suspendedDate": { "type": "string", "format": "date-time", "example": "2024-04-14T20:00:00.000-04:00", "description": "The Date the service was suspended" }, "cancelledDate": { "type": "string", "format": "date-time", "example": "2024-05-28T20:00:00.000-04:00", "description": "The Date the service was cancelled" }, "accessOptions": { "type": "array", "items": { "$ref": "#/components/schemas/AccessOptions" } }, "device": { "$ref": "#/components/schemas/Device" }, "feature": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "ratePlan": { "$ref": "#/components/schemas/RatePlan" }, "enterpriseInstallmentPlan": { "$ref": "#/components/schemas/EnterpriseInstallmentPlan" }, "subscriberPPUaddress": { "type": "object", "title": "Address", "required": [ "addressLine1", "state", "zipCode", "city" ], "properties": { "addressLine1": { "type": "string", "title": "Address Line 1", "example": "123 Main St", "description": "Address Line 1" }, "addressLine2": { "type": "string", "title": "Address Line 2", "example": "Suite 400", "description": "Address Line 2" }, "city": { "type": "string", "title": "City", "example": "Dallas", "description": "City" }, "state": { "type": "string", "title": "State", "example": "TX", "description": "State" }, "zipCode": { "type": "string", "title": "Zip Code", "example": "75201", "pattern": "^\\d{5}$", "description": "Zip Code" } }, "description": "The address of a Pay-Per-Use (PPU) subscriber" }, "udl": { "type": "array", "items": { "$ref": "#/components/schemas/UDL" }, "description": "Universal Data Label containing key value pairs of (Type and Value)" } } } } }, "OrderStatusResponse": { "type": "object", "required": [ "orderStatusResponse" ], "properties": { "orderStatusResponse": { "type": "object", "required": [ "statusType", "status" ], "properties": { "status": { "type": "array", "items": { "$ref": "#/components/schemas/Status" }, "description": "Status" }, "statusType": { "enum": [ "CareOrder", "StoreOrder" ], "type": "string", "title": "Order Status Type", "example": "StoreOrder", "description": "Status Type" } } } } }, "GenerateReportRequest": { "type": "object", "required": [ "generateReportRequest" ], "properties": { "generateReportRequest": { "type": "object", "required": [ "accountGroupId", "accountType", "accountLevelValue", "reportType" ], "properties": { "accountGroupId": { "type": "string", "example": "a98765432109", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group Id." }, "ctn": { "type": "string", "example": "5555055525", "pattern": "^\\d{10}$", "description": "Customer Telephone Number (10 digit)" }, "accountType": { "type": "string", "example": "FAN", "description": "Generate report at FAN level or BAN level." }, "accountLevelValue": { "type": "string", "example": "12345678", "description": "FAN or BAN number based on accountType." }, "reportType": { "enum": [ "catalogExtract", "wirelessInventory", "ratePlan", "orderHistory", "upgradeEligibility", "wirelessAccountLockHistory", "wirelessExceptionListHistory" ], "type": "string", "title": "Report Request Type", "example": "wirelessInventory", "description": "Report Type." }, "dateRange": { "$ref": "#/components/schemas/RangeDate" } } } }, "description": "Generate Report Request." }, "RetrieveReportRequest": { "type": "object", "required": [ "retrieveReportRequest" ], "properties": { "retrieveReportRequest": { "type": "object", "required": [ "accountGroupId", "accountType", "accountLevelValue", "reportType" ], "properties": { "accountGroupId": { "type": "string", "example": "a98765432109", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group Id." }, "ctn": { "type": "string", "example": "5555055525", "pattern": "^\\d{10}$", "description": "Customer Telephone Number (10 digit)" }, "accountType": { "type": "string", "example": "FAN", "description": "Generate report at FAN level or BAN level." }, "accountLevelValue": { "type": "string", "example": "12345678", "description": "FAN or BAN number based on accountType." }, "reportType": { "enum": [ "catalogExtract", "wirelessInventory", "ratePlan", "orderHistory", "upgradeEligibility", "wirelessAccountLockHistory", "wirelessExceptionListHistory" ], "type": "string", "title": "Report Request Type", "example": "wirelessInventory", "description": "Report Type." } } } }, "description": "Retrieve Report Request." }, "exceptionStatusDetail": { "type": "object", "title": "ExceptionStatusDetail", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "Status of transaction Success or Failure." }, "errorCode": { "type": "string", "description": "Exception Status Detail - Error Code." }, "errorDescription": { "type": "string", "description": "Exception Status Detail - Error Description." } }, "description": "Status of the transaction to be sent in response." }, "GenerateReportResponse": { "type": "object", "required": [ "generateReportResponse" ], "properties": { "generateReportResponse": { "type": "object", "properties": { "reportCode": { "type": "string", "example": "SC_REPORTS_1001", "description": "Report Status Code." }, "reportDescription": { "type": "string", "example": "Generating Reports is in process.", "description": "Report Status Description." } } } }, "description": "Generate Report Response." }, "RetrieveReportResponse": { "type": "object", "required": [ "retrieveReportResponse" ], "properties": { "retrieveReportResponse": { "type": "object", "required": [ "fileContent", "fileName", "fileDescription", "fileSize", "fileType" ], "properties": { "fileContent": { "type": "string", "example": "VGhpcyBpcyB0aGUgcmVwb3J0IG91dHB1dC4=", "description": "File Content Base64 Encoded." }, "fileName": { "type": "string", "example": "expandedWirelessInventoryReport_2024-06-07_18-8cef2a2906-d7af-5669-4f13-bd7a8cef2a29.zip", "description": "File Name." }, "fileDescription": { "type": "string", "example": "expandedWirelessInventoryReport_2024-06-07_18-8cef2a2906-d7af-5669-4f13-bd7a8cef2a29.zip", "description": "File Description." }, "fileSize": { "type": "string", "example": "8236", "description": "File Size." }, "fileType": { "enum": [ "CSV", "cXML", "txt" ], "type": "string", "title": "File Type", "example": "CSV", "description": "File Type." } } } }, "description": "RetrieveReportResponse" }, "SkuAvailabilityRequest": { "type": "object", "required": [ "skuAvailabilityRequest" ], "properties": { "skuAvailabilityRequest": { "type": "object", "required": [ "accountGroupId", "skuId" ], "properties": { "accountGroupId": { "type": "string", "title": "AccountGroupId", "example": "a98765432109", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group ID" }, "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" } } } }, "description": "SKU Availability Request." }, "SkuAvailabilityResponse": { "type": "object", "required": [ "skuAvailabilityResponse" ], "properties": { "skuAvailabilityResponse": { "type": "object", "properties": { "skuId": { "type": "string", "title": "SKUId", "example": "sku1234567890", "description": "SKU ID" }, "skuDescription": { "type": "string", "title": "SKUDescription", "example": "Apple iPhone 15 Plus (256GB Black)", "description": "SKU Description" }, "availableQuantity": { "type": "integer", "title": "AvailableQuantity", "example": 1234, "description": "Available Quantity" }, "skuAvailability": { "type": "boolean", "title": "SKUAvailability", "example": true, "description": "Sku Availability" }, "shipmentCommitDays": { "type": "object", "title": "ShipmentCommitDays", "required": [ "fromDays", "toDays" ], "properties": { "fromDays": { "type": "integer", "title": "FromDays", "default": 0, "example": 3, "description": "Minimum number of days expected to be shipped in" }, "toDays": { "type": "integer", "title": "ToDays", "default": 0, "example": 5, "description": "Maximum number of days expected to be shipped in" } }, "description": "Range of days expected to be shipped within" } } } }, "description": "SKU Availability Response." }, "OrderCancellationRequest": { "type": "object", "required": [ "orderCancellationRequest" ], "properties": { "orderCancellationRequest": { "type": "object", "required": [ "accountGroupId", "cancelOrders", "orderContact" ], "properties": { "accountGroupId": { "type": "string", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group Id.", "example": "a1234567890" }, "cancelOrders": { "type": "array", "items": { "$ref": "#/components/schemas/CancelOrders" }, "maxItems": 100 }, "orderContact": { "$ref": "#/components/schemas/OrderContact_1" } } } }, "description": "OrderCancellationRequest." }, "ManageListDetailsRequest": { "type": "object", "title": "ManageListDetails", "required": [ "billingAccountNumber" ], "properties": { "enableLock": { "type": "string", "description": "Enable Lock" }, "ctnException": { "type": "array", "items": { "$ref": "#/components/schemas/items_9" }, "maxItems": 25, "description": "List of CTNs to be added/removed to exceptionList" }, "billingAccountNumber": { "type": "string", "description": "Billing account number." }, "billingAccountNumberTransactionException": { "type": "array", "items": { "$ref": "#/components/schemas/items_8" }, "maxItems": 3, "description": "Transaction to be added/removed to exceptionList for a BAN." } }, "description": "List of details to be added or removed to the lockList." }, "CurrentUsageReportRequest": { "type": "object", "required": [ "currentUsageReportRequest" ], "properties": { "currentUsageReportRequest": { "type": "object", "required": [ "ctn" ], "properties": { "ctn": { "type": "string", "example": "5555055525", "pattern": "^\\d{10}$", "description": "Customer Telephone Number (10 digit)" } } } }, "description": "Current Usage Report Request." }, "EnterpriseInstallmentPlan": { "type": "object", "properties": { "id": { "type": "string", "example": "280110078026622" }, "agreementDate": { "type": "string", "example": "2024-05-04T00:00:00.000-05:00" }, "totalTerm": { "type": "string", "example": "36" }, "monthlyInstallment": { "type": "string", "example": "22.23" }, "installmentPlanTotal": { "type": "string", "example": "799.99" }, "paidToDate": { "type": "string", "example": "0.0" }, "pendingInstallments": { "type": "string", "example": "755.53" }, "earlyPayOffAmount": { "type": "string", "example": "799.99" } }, "description": "Enterprise Installment Plan" }, "ManageListDetailsResponse": { "type": "object", "title": "ManageListDetails", "required": [ "billingAccountNumber" ], "properties": { "enableLock": { "type": "string", "description": "Enable Lock" }, "ctnException": { "type": "array", "items": { "$ref": "#/components/schemas/items_11" }, "maxItems": 25, "description": "List of CTNs to be added/removed to exceptionList" }, "billingAccountNumber": { "type": "string", "description": "Billing account number." }, "exceptionStatusDetail": { "$ref": "#/components/schemas/exceptionStatusDetail" }, "billingAccountNumberTransactionException": { "type": "array", "items": { "$ref": "#/components/schemas/items_10" }, "maxItems": 3, "description": "Transaction to be added/removed to exceptionList for a BAN." } }, "description": "List of details to be added or removed to the lockList." }, "CurrentUsageReportResponse": { "type": "object", "required": [ "currentUsageReportResponse" ], "properties": { "currentUsageReportResponse": { "type": "object", "required": [ "fileContent", "fileName", "fileExtension" ], "properties": { "fileContent": { "type": "string", "example": "VGhpcyBpcyB0aGUgcmVwb3J0IG91dHB1dC4=", "description": "File Content Base64 Encoded." }, "fileName": { "type": "string", "example": "1234567890_Mangov6_2024-05-04-18-37-59_currentUsage", "description": "File Name." }, "fileExtension": { "type": "string", "example": "csv", "description": "File Extension." } } } }, "description": "Current Usage Report Response." }, "WirelessAccountLockRequest": { "type": "object", "required": [ "wirelessAccountLockRequest" ], "properties": { "wirelessAccountLockRequest": { "type": "object", "required": [ "accountGroupId", "foundationAccountNumber", "manageListDetails" ], "properties": { "accountGroupId": { "type": "string", "pattern": "^[\\w\\d]*$", "minLength": 6, "maxLength": 40, "description": "Account Group ID", "example": "a98765432109" }, "manageListDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ManageListDetailsRequest" }, "maxItems": 100, "description": "List of details to be added or removed to the lockList." }, "foundationAccountNumber": { "type": "string", "description": "A unique number to group customer accounts across all markets. (Note: Add leading zero(s) to create an 8 digit number.)" } } } }, "description": "WirelessAccountLockRequest." }, "WirelessAccountLockResponse": { "type": "object", "required": [ "wirelessAccountLockResponse" ], "properties": { "wirelessAccountLockResponse": { "type": "object", "properties": { "manageListDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ManageListDetailsResponse" }, "maxItems": 100, "description": "List of details to be added or removed to the lockList." } } } }, "description": "WirelessAccountLockResponse." } } } }