Overview
When provide orders complete asset records are created for the provided products. These assets are used as the basis for modify and cease orders as well as providing a source of inventory information for other systems related to fault and service management.
For API originated product orders, relevant information about such products including asset ids, allocated IP addresses and order completion dates is returned in order KSUs in the form of product order state change events.
However for portal orders, this information is only shared via the hub portal and emails.
The product list API, in response to a query using the customer facing service id (the reference starting BBONE, for example BBONE90099580), returns the information recorded in the hub about the asset. Note that at the time of the query the response will reflect the state of the asset as of the last completed order including any modifies, suspends or resumes applied to the asset since its creation.
Request Method and URI string
GET /tmf/productInventory/v4/product?serviceId=BBONE90099580Response Entity Body
The response below represents the asset record for a SOGEA 80/20 service with Basic Care and Dynamic IP which was "self installed" and sometime since has been suspended and resumed. SOGEA 80_20 is the "parent" asset referenced by all the other "children".
For a cease order the parent is the key to ceasing the service (all children are automatically ceased).
For a modify the parent is the root for the alteration of product features and the adding and removing of child products such as care packages, dynamic/static IP, and the taken out of service product.
The JSON is presented as a "flattened" array of all the assets which make up the provisioned product. Note, that this structure does not directly mirror the product offerings referenced in orders placed to create it as some internal assets are added to complete the provision.
Managed install assets are of no interest in modifies or ceases as they have no bearing on the lifecycle of the asset. Similarly anything marked with "isCustomerVisible":false is an internal asset not to be referenced in a modify or cease. Any "BB One Taken out of Service" products are relevant only to modifies related to the management of suspend and resume.
Taking the example below, diagrammatically the assets of interest for cease and modify are as shown. In the ordering model the Broadband Access product and its "invisible" Broadband Access_PS product and its attributes are combined into the parent product for any modifies.
[
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "SOGEA 80_20M",
"id": "E0000432"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000432"
},
"productCharacteristic": [
{
"value": "ChargingCategory20",
"name": "ChargingCategory"
},
{
"value": "Month",
"name": "ATT_RT_ContractTermUnit"
},
{
"value": "12",
"name": "ATT_RT_ContractTerm"
}
],
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Offer",
"status": "Active",
"terminationDate": null,
"startDate": "2024-04-02",
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": true,
"name": "SOGEA 80_20M",
"id": "70fc2d06-000f-5291-bde5-a9f315b18699"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "Basic Care",
"id": "E0000154"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "70fc2d06-000f-5291-bde5-a9f315b18699"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000154"
},
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Offer",
"status": "Active",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": true,
"name": "Basic Care",
"id": "5383942c-c15a-989a-53ef-295711062f77"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "Basic Care_PS",
"id": "E0000118"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "5383942c-c15a-989a-53ef-295711062f77"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000118"
},
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Product",
"status": "Active",
"terminationDate": null,
"startDate": "2024-04-02",
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": false,
"name": "Basic Care_PS",
"id": "e8fcb202-6d7d-9842-7969-07af0a6dfceb"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "Broadband Access",
"id": "E0000022"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "70fc2d06-000f-5291-bde5-a9f315b18699"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000022"
},
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Offer",
"status": "Active",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": true,
"name": "Broadband Access",
"id": "b3a30578-b51a-3b58-46b6-873c15a06b21"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"realizingResource": {
"@referredType": "Resource",
"name": "RealizingResource",
"id": "FBTH0234408"
},
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "Broadband Access_PS",
"id": "T2000006"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "b3a30578-b51a-3b58-46b6-873c15a06b21"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "T2000006"
},
"productCharacteristic": [
{
"value": "Standard",
"name": "ATT_RT_TrafficWeighting"
},
{
"value": "BBSLT_SOGEA 80_20M",
"name": "ATT_RT_ServiceLineType"
},
{
"value": "New",
"name": "ATT_RT_AccessLineType"
},
{
"value": "SOGEA",
"name": "ATT_RT_AccessTechnology"
},
{
"value": "",
"name": "ATT_RT_MigrationReason"
},
{
"value": null,
"name": "ATT_RT_ONTType"
},
{
"value": null,
"name": "ATT_RT_ONTReferenceNumber"
},
{
"value": null,
"name": "ATT_RT_ONTPortNumber"
},
{
"value": null,
"name": "ATT_DT_OfficialDownloadSpeed"
},
{
"value": null,
"name": "ATT_DT_OfficialUploadSpeed"
},
{
"value": null,
"name": "ATT_RT_HeadlineDownloadSpeed"
},
{
"value": null,
"name": "ATT_RT_HeadlineUploadSpeed"
},
{
"value": "Business",
"name": "ATT_RT_EndUserType"
},
{
"value": "0Kbit/s",
"name": "ATT_DT_RealTime"
},
{
"value": "Stable",
"name": "ATT_DT_StabilityOption"
},
{
"value": "BVF",
"name": "ATT_RT_ResellerID"
},
{
"value": "S",
"name": "ATT_RT_InstallType"
},
{
"value": "None",
"name": "ATT_RT_NumberExportRequired"
},
{
"value": null,
"name": "ATT_RT_PortingProcess"
},
{
"value": null,
"name": "ATT_RT_donorPSTNNumber"
},
{
"value": null,
"name": "ATT_RT_CUPID"
},
{
"value": null,
"name": "ATT_RT_FixedPortingDate"
},
{
"value": null,
"name": "ATT_RT_FixedPortingTime"
},
{
"value": null,
"name": "ATT_RT_ProductLowUploadSpeed"
},
{
"value": null,
"name": "ATT_RT_ProductHighUploadSpeed"
},
{
"value": null,
"name": "ATT_RT_ProductLowDownloadSpeed"
},
{
"value": null,
"name": "ATT_RT_ProductHighDownloadSpeed"
},
{
"value": null,
"name": "ATT_RT_ProductMinimumGuaranteedSpeed"
},
{
"value": null,
"name": "ATT_RT_ProductAdvertisedUploadSpeed"
},
{
"value": null,
"name": "ATT_RT_ProductAdvertisedDownloadSpeed"
},
{
"value": null,
"name": "ATT_RT_DirectoryNumber"
},
{
"value": null,
"name": "ATT_RT_UpperUpstreamObservedSpeed"
},
{
"value": null,
"name": "ATT_RT_UpperDownstreamObservedSpeed"
},
{
"value": null,
"name": "ATT_RT_ExchangePrefix"
},
{
"value": "BBEU56007094",
"name": "WBCServiceID"
},
{
"value": null,
"name": "existingLineProductType"
},
{
"value": null,
"name": "ATT_DT_RecommendedMinimumLeadTime"
},
{
"value": "1",
"name": "ATT_DT_ChannelIdentifier"
},
{
"value": null,
"name": "ATT_DT_BroadbandVariant"
},
{
"value": null,
"name": "ATT_DT_InWhichProduct"
}
],
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Product",
"status": "Active",
"terminationDate": null,
"startDate": "2024-04-02",
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": false,
"name": "Broadband Access_PS",
"id": "69805c51-6ea5-5b78-eb10-ea38b73f9232"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "Dynamic IP",
"id": "E0000703"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "70fc2d06-000f-5291-bde5-a9f315b18699"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000703"
},
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Offer",
"status": "Active",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": true,
"name": "Dynamic IP",
"id": "313c707f-bf1d-e44b-b690-447db9758b1e"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "Dynamic IP_PS",
"id": "E0000702"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "313c707f-bf1d-e44b-b690-447db9758b1e"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000702"
},
"productCharacteristic": [
{
"value": "N",
"name": "CGNAT_FLAG"
},
{
"value": "N",
"name": "IPV4V6_FLAG"
},
{
"value": null,
"name": "ATT_RT_GatewayIPAddress"
},
{
"value": null,
"name": "ATT_RT_EndIPAddress"
},
{
"value": null,
"name": "ATT_RT_StartIPAddress"
},
{
"value": null,
"name": "ATT_RT_StaticIPv6Prefix"
},
{
"value": null,
"name": "ATT_RT_StaticIPType"
},
{
"value": null,
"name": "ATT_DT_NoofIPs"
}
],
"place": [
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "SiteAddress",
"id": "R09597344261"
},
{
"@type": "BTRelatedPlaceRefOrValue",
"role": "OpenreachAddress",
"id": "A00018816949"
}
],
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Product",
"status": "Active",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": false,
"name": "Dynamic IP_PS",
"id": "4c007fc1-6405-b368-fcd7-c4f7fef15f97"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "BB One Taken out of Service",
"id": "E0000999"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000999"
},
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Offer",
"status": "Deleted",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": true,
"name": "BB One Taken out of Service",
"id": "845bc9cb-9db2-9e64-1d5f-8b1a0c622f1d"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "PS BB One Taken out of Service",
"id": "E0001000"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "845bc9cb-9db2-9e64-1d5f-8b1a0c622f1d"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0001000"
},
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Product",
"status": "Deleted",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": false,
"name": "PS BB One Taken out of Service",
"id": "4e7175aa-af3a-dda8-a1f9-ac4e66ad9f3d"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "BB One Taken out of Service",
"id": "E0000999"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0000999"
},
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Offer",
"status": "Deleted",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": true,
"name": "BB One Taken out of Service",
"id": "b5686e5f-c531-028a-e384-1c5d35bfc275"
},
{
"relatedParty": [
{
"@referredType": "BtCug",
"role": "customer",
"id": "CUG5009999999"
},
{
"@referredType": "BTRelatedParty",
"role": "EndCustomer",
"id": "A00018816949"
}
],
"ProductSpecification": {
"@referredType": "ProductSpecification",
"name": "PS BB One Taken out of Service",
"id": "E0001000"
},
"productRelationship": {
"@relationshipType": "Parent",
"@referredType": "ProductOffering",
"id": "b5686e5f-c531-028a-e384-1c5d35bfc275"
},
"productOffering": {
"@referredType": "ProductOffering",
"id": "E0001000"
},
"billingAccount": {
"@referredType": "BillingAccount",
"name": "XYZ TELECOM LTD Billing",
"id": "0455999999"
},
"@type": "Product",
"status": "Deleted",
"terminationDate": null,
"startDate": null,
"productSerialNumber": "BBONE90099580",
"isCustomerVisible": false,
"name": "PS BB One Taken out of Service",
"id": "55cae35e-4ab3-0f5d-b8e8-3853b28b514b"
}
]