{ "openapi": "3.0.3", "info": { "version": "1.0.0", "title": "Submit order", "description": "This is OpenAPI Spec APIs for external partners to invoke the submit order.", "contact": { "name": "Omni API Support", "email": "DL-OmniAdapter@att.com" } }, "servers": [ { "url": "https://partner-omni-apis.att.com/omni-svcs" } ], "tags": [ { "name": "sales-operations", "description": "Sales Operation" }, { "name": "orders-graphQL", "description": "Orders view" } ], "paths": { "/v1/order/{orderid}/submit": { "post": { "tags": [ "sales-operations" ], "description": "Order submission", "summary": "Submit order", "operationId": "submitOrder", "parameters": [ { "name": "orderid", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Order ID" } ], "responses": { "200": { "$ref": "#/components/responses/SubmitOrderResponse" }, "400": { "$ref": "#/components/responses/SubmitOrderErrorResponse" } } } }, "/v1/orders/query": { "post": { "tags": [ "orders-graphQL" ], "summary": "GraphQL API to Retrieve Order Information", "description": "Retreive Order information based on order Filter", "operationId": "queryOrdersGraphQL", "parameters": [ { "in": "header", "name": "serviceType", "schema": { "type": "string", "enum": [ "wireless", "wirelessbroadband", "fiber" ] }, "description": "account type", "required": true }, { "in": "header", "name": "idp-trace-id", "schema": { "type": "string", "format": "uuid" }, "required": false }, { "in": "header", "name": "topics", "schema": { "type": "string", "enum": [ "accounts", "individuals", "products", "contracts", "subscribers", "equipment" ] }, "description": "default to accounts", "required": true }, { "in": "header", "name": "idpctx-session-id", "schema": { "type": "string", "format": "uuid" }, "required": false } ], "requestBody": { "description": "description", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string", "example": "{ getOrders(filter:{ orderId: \"56-813000062156271\", accountNumber: \"mobileOffer\",orderDate: \"2024-10-15\", lineOfBusiness: \"ws\", limit: 50, offset: 0}) {orders {id orderId parentOrderId orderDate canceledDate orderStatus{status} customer{ firstName } fulfillments{ fulfillmentStatus{status}} products{ productStatus {status} lines{lineType name} items{deviceDetails{model IMEI}}} accounts{ accountNumber } returnOrderDetails{commonOrderId } orderPrice{total} pointOfNoReturnDate orderErrorInfoList{ errorInfo } }pageInfo{totalCount pageSize pageNumber} } }" } } } } } }, "responses": { "200": { "description": "Successful response with individual data", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrderResponse" } ] }, "examples": { "getOrders_query_response": { "value": { "orderId": "25-754322252600371", "revision": "2", "orderDate": "2025-08-04T16:09:32.101Z", "fulfillments": [ { "fulfillmentSequence": "1", "fulfillmentType": "DF", "productSequenceNumber": [ "1" ], "fulfillmentStatus": {} } ], "customer": { "individualId": "ffb2fdc0-4a9c-41bb-a3be-2df46ee51f0d" }, "products": [ { "action": "add", "name": "Wireless", "lines": [ { "characteristics": [ { "name": "Number_Management_Resource_Identifier", "value": "019875c3-ce4f-7598-a768-a899548cd2f9", "id": "1" } ], "id": "f29de683-b93f-41a2-9120-d8e0c6552bc7", "services": [ { "name": "AT&T Unlimited Level Up" } ] }, { "characteristics": [ { "name": "Number_Management_Resource_Identifier", "value": "019875c3-f4ca-78b3-b4a8-b8e8d30e8b3a", "id": "1" } ], "id": "ea42f182-4a23-4f78-9587-aef5118ae355", "services": [ { "name": "AT&T Unlimited Level Up" } ] } ], "items": [ { "id": "618d7f13-2189-4282-836e-a9218c8a4d88", "lineSequence": "1", "itemAction": "add", "alternateItemProductIds": [], "itemSequence": "1", "fulfillmentSequence": "1", "itemProductId": { "value": "6453E", "type": "sku" }, "itemDescription": "Samsung Galaxy A15 5G - AT&T PREPAID - 64GB - Blue Black", "itemType": "P", "productOrderItemRelationship": [ { "id": "9699a170-f72c-4437-8d70-a45c240bb3d5" } ] }, { "id": "304a2f0a-149f-4e71-ba55-9c6aa7ffff15", "lineSequence": "1", "itemAction": "add", "alternateItemProductIds": [], "itemSequence": "2", "fulfillmentSequence": "1", "itemProductId": { "value": "73023", "type": "sku" }, "itemDescription": "AT&T PREPAID pSIM Card", "itemType": "S", "productOrderItemRelationship": [ { "id": "9699a170-f72c-4437-8d70-a45c240bb3d5" } ] }, { "id": "657e166c-2bdd-44b8-82b1-017fcb7e78ec", "lineSequence": "2", "itemAction": "add", "alternateItemProductIds": [], "itemSequence": "3", "fulfillmentSequence": "1", "itemProductId": { "value": "6453E", "type": "sku" }, "itemDescription": "Samsung Galaxy A15 5G - AT&T PREPAID - 64GB - Blue Black", "itemType": "P", "productOrderItemRelationship": [ { "id": "9699a170-f72c-4437-8d70-a45c240bb3d5" } ] }, { "id": "e12b9748-dca5-4eea-924b-e886b3fbbc58", "lineSequence": "2", "itemAction": "add", "alternateItemProductIds": [], "itemSequence": "4", "fulfillmentSequence": "1", "itemProductId": { "value": "73023", "type": "sku" }, "itemDescription": "AT&T PREPAID pSIM Card", "itemType": "S", "productOrderItemRelationship": [ { "id": "9699a170-f72c-4437-8d70-a45c240bb3d5" } ] }, { "id": "9699a170-f72c-4437-8d70-a45c240bb3d5", "lineSequence": "1", "itemAction": "add", "alternateItemProductIds": [], "itemSequence": "5", "fulfillmentSequence": "1", "itemProductId": { "value": "RS3", "type": "sku" }, "itemDescription": "Standard Shipping", "itemType": "D", "productOrderItemRelationship": [ { "id": "e12b9748-dca5-4eea-924b-e886b3fbbc58" }, { "id": "657e166c-2bdd-44b8-82b1-017fcb7e78ec" }, { "id": "618d7f13-2189-4282-836e-a9218c8a4d88" }, { "id": "304a2f0a-149f-4e71-ba55-9c6aa7ffff15" } ] } ] } ], "accounts": [ { "accountNumber": "557966159397" } ], "orderPrice": { "total": 340.11 } } }, "getDraftOrders_query_response": { "value": { "TBD": "TBD" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "errorCode": "400", "errorDescription": "invalid request" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "unauthorized_request": { "value": { "errorCode": "401", "errorDescription": "Access Token invalid or Missing." } } } } } } } } } }, "components": { "responses": { "SubmitOrderResponse": { "description": "Submit order response", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "description": "Order state" }, "submissionDate": { "type": "string", "description": "Order submissionDate" } } } } } }, "SubmitOrderErrorResponse": { "description": "SubmitOrder Error Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "description": "Order state" }, "validation": { "$ref": "#/components/schemas/Validation" }, "error": { "$ref": "#/components/schemas/Error" } } } } } }, "SubmitOrderFraudResponse": { "description": "SubmitOrder Fraud Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "validation": { "$ref": "#/components/schemas/Validation" }, "fraud": { "$ref": "#/components/schemas/FraudMitigationResponse" } } } } } } }, "schemas": { "Error": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "<400-INVALID-REQUEST>" }, "errorDescription": { "type": "string", "example": "Validation Failure" }, "errorList": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "example": "terms", "description": "Holds the action that is being perfomed causing the error" }, "errorCode": { "type": "string", "example": "XXX" }, "errorDescription": { "type": "string", "example": "xxx" }, "errorDetails": { "type": "array", "items": { "type": "object", "properties": { "system": { "type": "string", "example": "xx" }, "errorCode": { "type": "string", "example": "XXX" }, "errorDescription": { "type": "string", "example": "XXX" } } } } } } } } }, "Validation": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the order" }, "readyToSubmit": { "type": "boolean", "description": "Indicates if the order is ready to submit" }, "validationMessage": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Validation message text" }, "type": { "type": "string", "description": "Component type" }, "parameter": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Holds the value for any line level error ids" }, "value": { "type": "string", "description": "Value of the parameter name" } } } } } } }, "configuration": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Configuration type" }, "status": { "type": "string", "description": "Configuration status" }, "required": { "type": "boolean", "description": "Indicates if the configuration is required" }, "postOrderConfigurable": { "type": "boolean", "description": "Indicates if the configuration is post-order configurable" } } } } } }, "FraudMitigationResponse": { "type": "object", "properties": { "fraudMitigation": { "type": "array", "items": { "$ref": "#/components/schemas/FraudMitigationItem" } } } }, "FraudMitigationItem": { "type": "object", "properties": { "mitigationDescription": { "type": "string", "description": "Mitigation description on what type of mitigation" }, "mitigationId": { "type": "string", "description": "Mitigation Id Unique for each mitigation record" }, "mitigationPriority": { "type": "string" }, "emailForOTPList": { "type": "array", "items": { "type": "string", "format": "email" } }, "ctnForOTPList": { "type": "array", "items": { "type": "string" } } } }, "GraphqlQuery": { "type": "object", "properties": { "query": { "type": "string" } } }, "OrderResponse": { "type": "object", "properties": { "id": { "type": "string" }, "accountNumber": { "type": "string" }, "orderDate": { "type": "string" }, "lineOfBusiness": { "type": "string" }, "customerTelephoneNumber": { "type": "string" }, "storeId": { "type": "string" }, "storeName": { "type": "string" }, "orderStatus": { "type": "string" }, "canceledDate": { "type": "string" } } }, "DraftOrderResponse": { "type": "object", "properties": { "id": { "type": "string" }, "accountNumber": { "type": "string" }, "orderDate": { "type": "string" }, "lineOfBusiness": { "type": "string" }, "customerTelephoneNumber": { "type": "string" }, "orderStatus": { "type": "string" }, "canceledDate": { "type": "string" } } }, "Individual": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "languageAbility": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageAbility" } }, "status": { "type": "string" }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, "LanguageAbility": { "type": "object", "properties": { "languageCode": { "type": "string" }, "languageName": { "type": "string" } } }, "ContactMedium": { "type": "object", "properties": { "mediumType": { "type": "string" }, "isPreferred": { "type": "boolean" }, "characteristic": { "$ref": "#/components/schemas/Characteristic" } } }, "Characteristic": { "type": "object", "properties": { "contactType": { "type": "string" }, "phoneNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "place": { "$ref": "#/components/schemas/Place" } } }, "Place": { "type": "object", "properties": { "id": { "type": "string" } } }, "Account": { "type": "object", "properties": { "id": { "type": "string" }, "accountType": { "type": "string" }, "accountSubType": { "type": "string" }, "liabilityType": { "type": "string" }, "businessType": { "type": "string" }, "ratingType": { "type": "string" }, "serviceType": { "type": "string" }, "firstNetIndicator": { "type": "string" }, "subscribersCount": { "type": "integer" }, "accountState": { "$ref": "#/components/schemas/AccountState" }, "accountLocked": { "type": "boolean" }, "extraSecurityCode": { "type": "string" }, "fanDetails": { "$ref": "#/components/schemas/FanDetails" }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "bill": { "$ref": "#/components/schemas/Bill" }, "subscribers": { "type": "array", "items": { "$ref": "#/components/schemas/Subscriber" } } } }, "AccountState": { "type": "object", "properties": { "state": { "type": "string" } } }, "FanDetails": { "type": "object", "properties": { "fanId": { "type": "string" }, "fanDescription": { "type": "string" } } }, "Contact": { "type": "object", "properties": { "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } } } }, "Bill": { "type": "object", "properties": { "billStructure": { "$ref": "#/components/schemas/BillStructure" } } }, "BillStructure": { "type": "object", "properties": { "presentationMedia": { "type": "array", "items": { "$ref": "#/components/schemas/PresentationMedia" } }, "cycleSpecification": { "$ref": "#/components/schemas/CycleSpecification" } } }, "PresentationMedia": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "CycleSpecification": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "frequency": { "type": "string" } } }, "Subscriber": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Status" }, "subscriberType": { "type": "string" }, "phoneNumber": { "type": "string" }, "isPreferredCTN": { "type": "boolean" }, "isFirstNetSubscriber": { "type": "boolean" }, "contactMedium": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMedium" } }, "profile": { "$ref": "#/components/schemas/Profile" }, "serviceCharacteristic": { "$ref": "#/components/schemas/ServiceCharacteristic" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } }, "Status": { "type": "object", "properties": { "status": { "type": "string" } } }, "Profile": { "type": "object", "properties": { "individualId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } } }, "ServiceCharacteristic": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } }, "Device": { "type": "object", "properties": { "type": { "type": "string" }, "imei": { "type": "string" }, "imeiType": { "type": "string" }, "sim": { "$ref": "#/components/schemas/Sim" } } }, "Sim": { "type": "object", "properties": { "iccid": { "type": "string" }, "imsi": { "type": "string" } } }, "Product": { "type": "object", "properties": { "productOfferingTypeGroup": { "type": "string" }, "id": { "type": "string" }, "rootProductId": { "type": "string" }, "productOfferingId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "$ref": "#/components/schemas/Status" }, "productCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } } } }, "ProductCharacteristic": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "valueType": { "type": "string" } } }, "HealthCheck": { "title": "HealthCheck", "example": { "application_name": "customer-account-management", "message": "Application up and running", "time": "2025-05-025T20:10:26.843-05:00" }, "type": "object", "required": [ "application_name", "message", "time" ], "properties": { "application_name": { "type": "string" }, "message": { "type": "string" } } }, "ProductOfferList": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffer" } }, "ProductOffer": { "type": "object", "properties": { "id": { "type": "string", "example": "06c387fb-bfd5-4287-a1e8-b9da4c0be06e" }, "name": { "type": "string", "example": "Value Plus VL" }, "localizedName": { "type": "string", "example": "Value Plus VL" }, "description": { "type": "string", "example": "Value Plus VL" }, "productOfferingType": { "type": "string", "example": "Mobile_Offer" }, "productOfferingTypeGroup": { "type": "string", "example": "mobileOffer" }, "bundledProductOffering": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "example": "75c62382-0601-40a9-bc0b-05e7e153fa38" }, "name": { "type": "string", "example": "Value Plus VL" }, "productOfferingType": { "type": "string", "example": "Mobile_Plan" }, "productOfferingTypeGroup": { "type": "string", "example": "mobilePlan" }, "bundledProductOfferingOption": { "type": "array", "items": { "type": "object", "properties": { "productOfferingPrice": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "Value Plus VL" }, "priceCategory": { "type": "string", "example": "serviceRC" }, "priceType": { "type": "string", "example": "RC" }, "recurringChargePeriod": { "type": "string", "example": "month" }, "recurringChargePeriodLength": { "type": "number", "example": 1 }, "role": { "type": "string", "example": "Price" }, "price": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } } } } } } } }, "productOfferingTotalPrice": { "type": "array", "items": { "type": "object", "properties": { "priceType": { "type": "string", "example": "RC" }, "recurringChargePeriod": { "type": "string", "example": "month" }, "recurringChargePeriodLength": { "type": "number", "example": 1 }, "price": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } }, "finalPrice": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } }, "standalonePrice": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } }, "taxIncluded": { "type": "string", "example": "Excluded" } } } } } }, { "type": "object", "properties": { "id": { "type": "string", "example": "3e841296-e828-4c13-adf1-3115f6ccb614" }, "name": { "type": "string", "example": "AT&T ActiveArmor" }, "productOfferingType": { "type": "string", "example": "Active_Armor" }, "productOfferingTypeGroup": { "type": "string", "example": "mobileAddon" } } }, { "type": "object", "properties": { "id": { "type": "string", "example": "1e6d9cf0-13cc-49a9-9e19-907ef46d6eb3" }, "name": { "type": "string", "example": "International Day Pass" }, "productOfferingType": { "type": "string", "example": "Roaming_Package" }, "productOfferingTypeGroup": { "type": "string", "example": "mobileAddon" } } } ] } }, "productOfferingTotalPrice": { "type": "array", "items": { "type": "object", "properties": { "priceType": { "type": "string", "example": "RC" }, "recurringChargePeriod": { "type": "string", "example": "month" }, "recurringChargePeriodLength": { "type": "number", "example": 1 }, "price": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } }, "finalPrice": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } }, "standalonePrice": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "example": "USD" }, "value": { "type": "number", "example": 60.99 } } } } }, "taxIncluded": { "type": "string", "example": "Excluded" } } } }, "bundledProductOfferingGroupOption": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "groupOptionId": { "type": "string", "example": "3405d3a9-b60a-11ef-ae7c-ed7e3dc40175" }, "description": { "type": "string", "example": "Select SIM Card" }, "bundledProductOffering": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "790650ec-b512-4bee-ae7f-535668eadf1b" }, "name": { "type": "string", "example": "eSIM Activation" }, "productOfferingType": { "type": "string", "example": "SIM" }, "productOfferingTypeGroup": { "type": "string", "example": "sim" } } } } } }, { "type": "object", "properties": { "groupOptionId": { "type": "string", "example": "3405d3aa-b60a-11ef-ae7c-27965683c6f2" }, "description": { "type": "string", "example": "Select Device" }, "bundledProductOffering": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "c9715944-afed-42eb-a35f-51c2ced6bea4" }, "name": { "type": "string", "example": "Bring Your Own Phone" }, "productOfferingType": { "type": "string", "example": "Mobile_Device" }, "productOfferingTypeGroup": { "type": "string", "example": "mobileDevice" } } } } } } ] } } } } } } }