dxp-ux
Product-Inventory
LCPR listProduct [GET]
The listProduct API is used to retrieve a list of purchased products and Subscriber status.
Key points for Panama Bango Use case
- If @type == "OTT" using for routing puropose internally in ESB.
- For listProduct billingAccount.id and '@type' are mandatory queryParameters
- productSpecification.id and status are optional queryParameters.Examples:status: active, cancelled, aborted, suspended, pendingActiveproductSpecification.id: disneyPlus
Key points for LCPR Market
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/productBase URI Parameter
| Name | Type | M/O | Description |
|---|---|---|---|
| businessId | string | M | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit |
Headers
| Name | Type | M/O | Description |
|---|---|---|---|
| X-Correlation-ID | string | N | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request |
| lob | string | M | The Line of Business Identifier currently available are: PREPAID POSTPAID |
| channelId | string | M | Channel to business: In this case, expected channelId will be: APP (SuperApp), Qpay (RT2) Note - 'channelId' is mandatory for Mobile project |
| targetSystem | String | M | This describes the end system. “Matrixx” is in scope. |
Security Headers
| Name | Type | M/O | Description |
|---|---|---|---|
| client_id | string | M | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 |
| client_secret | string | M | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a |
Query Parameter
| name | type | description | required |
|---|---|---|---|
| publicIdentifier | string | Public identifier value of a product, like MSISDN Example:7095659489, Subscription Id Example:S-89194 Note - 'publicIdentifier' is mandatory for Mobile project | Y |
| publicIdentifierType | string | Public identifier type value. Aallowed values are MSISDN and SubscriptionId. Note - 'publicIdentifierType' is mandatory for Mobile project | Y |
URL dxp-ux/v1/{businessId}
curl --location 'https://nonprod.esb.cloud.lla.com/test/dxp-ux/dxp-ux/v1/{businessId}/product?publicIdentifier=S-225552-887890&publicIdentifierType=SubscriptionId' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92CCC' \
--header 'channelId: SFDC-B2C' \
--header 'lob: PREPAID' \
--header 'targetSystem: MATRIXX' \
--header 'client_id: xxx' \
--header 'client_secret: yyy'Key Points
For LCPR prepaid customers,
- API returns all products/subscriptions along with status.
- We can use this API to check if the customer number(MSISDN) is active or not. In response, if payload[x].@type=subscription and payload[x].status=Active it means MSISDN is active.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ] PREPAID
OK - listProduct request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "S-51537890",
"name": "Sub-ABC",
"description": "Subscription Info for msisdn 515378900",
"status": "Active",
"@type": "Subscription",
"productCharacteristic": [
{
"name": "LastActivityTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "UserCount",
"value": "1"
},
{
"name": "statusId",
"value": "1"
},
{
"name": "LLASubType",
"value": "1"
}
],
"relatedParty": [
{
"id": "SU-51537890",
"role": "Owner",
"@type": "SubscriptionUserRef"
}
],
"product": [
{
"id": "1",
"name": "Prepaid Subscription Setup",
"status": "active",
"startDate": "2024-12-06T05:24:17.000000-04:00",
"orderDate": "2024-12-06T05:24:17.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "Prepaid Subscription Setup",
"@type": "CatalogProductOfferRef"
},
"productTerm": [
{
"name": "1",
"duration": {
"amount": 1,
"units": "Monthly"
},
"validFor": {
"startDateTime": "2024-12-06T05:24:17.000000-04:00",
"endDateTime": "2025-01-06T05:24:17.000000-04:00"
},
"@type": "CycleInfoRef"
}
],
"productPrice": [
{
"productOfferingPrice": {
"id": "9",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "CycleModifyAllowed",
"value": "true"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "39"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "CPC",
"name": "CPN",
"@type": "BasePlan"
}
},
{
"id": "2",
"name": "Prepaid Balance",
"status": "active",
"startDate": "2024-12-06T05:24:17.000000-04:00",
"orderDate": "2024-12-06T05:24:17.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "11",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "1"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:17.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "PrimaryBalanceResourceId",
"value": "1"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "3",
"name": "PPU Bundle: Prepaid",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "LLA: PPU Services: Prepaid",
"@type": "CatalogProductOfferRef"
},
"productPrice": [
{
"productOfferingPrice": {
"id": "153",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "117"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "PR_B2C_Prepaid_16GB_Mobile_Line",
"name": "Prepaid 16GB Mobile Line",
"@type": "BasePlan"
}
},
{
"id": "4",
"name": "PPU Offer: Text",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "66",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "5",
"name": "PPU Offer: MMS",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "67",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "6",
"name": "PPU Offer: Data",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "68",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "7",
"name": "PPU Offer: Voice: Prepaid Roaming",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "149",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "8",
"name": "PPU Offer: Voice: Prepaid Long Distance",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "150",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "9",
"name": "PPU Offer: Voice: Prepaid Roaming: Terminated in PR/USVI",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "155",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "3"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "10",
"name": "Setup Services",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "LLA: Setup Services",
"@type": "CatalogProductOfferRef"
},
"productPrice": [
{
"productOfferingPrice": {
"id": "60",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "71"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "PR_B2C_Prepaid_16GB_Mobile_Line",
"name": "Prepaid 16GB Mobile Line",
"@type": "BasePlan"
}
},
{
"id": "11",
"name": "Setup Offer: Voice",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "57",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "12",
"name": "LLA: Setup Text",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "58",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "13",
"name": "LLA: Setup Data",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "59",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "14",
"name": "LLA: Setup MMS",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "62",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "10"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "15",
"name": "Prepaid Plan Attr - Shared Data",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "Prepaid_Template_Shared",
"@type": "CatalogProductOfferRef"
},
"productTerm": [
{
"name": "1",
"duration": {
"amount": 30,
"units": "Daily"
},
"validFor": {
"startDateTime": "2024-12-06T00:00:00.000000-04:00",
"endDateTime": "2025-01-05T00:00:00.000000-04:00"
},
"@type": "CycleInfoRef"
}
],
"productPrice": [
{
"productOfferingPrice": {
"id": "95",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "CycleModifyAllowed",
"value": "true"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "94"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "PR_B2C_Prepaid_16GB_Mobile_Line",
"name": "Prepaid 16GB Mobile Line",
"@type": "BasePlan"
}
},
{
"id": "16",
"name": "LLA: MMS Offer Template: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "92",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "17",
"name": "Sales Tax P1",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "79",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "18",
"name": "Sales Tax P2",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "80",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "19",
"name": "911 Fee Charge: Prepaid",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "144",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "20",
"name": "911 Fee Charge offset: Prepaid",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "145",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "21",
"name": "LLA: Voice Offer Template Intra: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "41",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "22",
"name": "LLA: SMS Offer Template: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "42",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "23",
"name": "LLA: Shared Data Offer Template: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "73",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "24",
"name": "LLA: Voice Offer Template Inter: Prepaid Recurring 30 Days",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "143",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
},
{
"id": "25",
"name": "LifelineDiscount: GL",
"status": "active",
"startDate": "2024-12-06T05:24:58.000000-04:00",
"orderDate": "2024-12-06T05:24:58.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "217",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "15"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2024-12-06T05:24:58.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": 478.16
},
{
"name": "BalanceResourceId",
"value": 1
}
]
}
]
}
][ 200 ] POSTPAID
OK - listProduct request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"id": "S-8201",
"name": "Sub-ABC",
"description": "Subscription Info for MSISDN 8201",
"status": "Active",
"@type": "Subscription",
"productCharacteristic": [
{
"name": "LastActivityTime",
"value": "2022-11-08T11:30:56.000000Z"
},
{
"name": "CurrentStatusTransitionTime",
"value": "2022-11-08T11:30:56.000000Z"
},
{
"name": "UserCount",
"value": "1"
}
],
"relatedParty": [
{
"id": "376920",
"role": "Owner",
"@type": "SubscriptionUserRef"
}
],
"product": [
{
"id": "1",
"name": "Postpaid Subscription Setup",
"status": "active",
"startDate": "2022-11-08T07:30:56.000000-04:00",
"orderDate": "2022-11-08T07:30:56.000000-04:00",
"@type": "BasePlan",
"productOffering": {
"id": "Postpaid Subscription Setup",
"@type": "CatalogProductOfferRef"
},
"productTerm": [
{
"name": "1",
"duration": {
"amount": 1,
"units": "Monthly"
},
"validFor": {
"startDateTime": "2022-11-08T07:30:56.000000-04:00",
"endDateTime": "2022-12-08T07:30:56.000000-04:00"
},
"@type": "CycleInfoRef"
}
],
"productPrice": [
{
"productOfferingPrice": {
"id": "10",
"@type": "ProductOfferingPriceRef"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2022-11-08T07:30:56.000000-04:00"
},
{
"name": "CycleModifyAllowed",
"value": "false"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "CatalogItemId",
"value": "38"
},
{
"name": "OfferType",
"value": "purchased_bundle"
},
{
"name": "AvailableAmount",
"value": "infinity"
},
{
"name": "BalanceResourceId",
"value": 1
}
],
"productSpecification": {
"id": "CPC",
"name": "CPN",
"@type": "BasePlan"
}
},
{
"id": "2",
"name": "Postpaid Balance",
"status": "active",
"startDate": "2022-11-08T07:30:56.000000-04:00",
"orderDate": "2022-11-08T07:30:56.000000-04:00",
"@type": "Plan",
"productPrice": [
{
"productOfferingPrice": {
"id": "53",
"@type": "ProductOfferingPriceRef"
}
}
],
"productRelationship": [
{
"relationshipType": "parent",
"product": {
"id": "1"
}
}
],
"productCharacteristic": [
{
"name": "CurrentStatusTransitionTime",
"value": "2022-11-08T07:30:56.000000-04:00"
},
{
"name": "OfferStatusDescription",
"value": "active"
},
{
"name": "OfferType",
"value": "bundle_purchased_offer"
},
{
"name": "AvailableAmount",
"value": "infinity"
},
{
"name": "BalanceResourceId",
"value": 1
}
]
}
]
}
]Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| id | string | External ID of the subscription. | N |
| name | string | Descriptive name of subscription. | N |
| description | string | Is the description of the response. Hard coded as static in Mule API. | N |
| status | string | Status of the subscription.Example: - created - pendingActive - cancelled - active - pendingTerminate - terminated -suspended - aborted | N |
| @type | string | The actual type of an response, @type as Subscription | N |
| productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair. Note - Please refer Customer Characteristic below for more details | N |
| productCharacteristic.name | string | Name of the characteristic | N |
| productCharacteristic.value | any | The value of the characteristic | N |
| productCharacteristic.valueType | string | Data type of the value of the characteristic | N |
| relatedParty | array | ||
| relatedParty.id | string | Subscription User unique Id at Matrixx | N |
| relatedParty.role | string | the role of subscription user | N |
| relatedParty.@type | string | Reference of subscription user | N |
| product | array | N | |
| product.id | string | Unique identifier for this offer (within subscriber/group). | N |
| product.name | string | External ID of product offer in pricing DB. | N |
| product.status | string | The offer status. | N |
| product.startDate | datetime | When the offer was activated. Not set if status is pre-active. If active at purchase time, ActivationTime and PurchaseTime have the same value. | N |
| product.orderDate | datetime | When the offer was purchased. | N |
| product.@type | string | type of product/offer | N |
| product.productOffering | object | A EntityRef is a detailed description of a bill structure. | N |
| product.productOffering.id | string | External ID of catalog item in pricing DB, if associated with a catalog item. I.e., not for purchased offers which are part of a bundle. | N |
| product.productOffering.@type | string | 'When sub-classing, this defines the sub-class entity name' | N |
| product.productTerm | array | N | |
| product.productTerm.name | string | Unique identifier for the purchased item cycle period. | N |
| product.productTerm.duration | object | N | |
| product.productTerm.duration.amount | number | Number of periods in a purchased item cycle. | N |
| product.productTerm.duration.units | string | The period type. 1=Hourly, 2=Daily, 3=Weekly, 4=Monthly, 5=Yearly, 6=Minutes" | N |
| product.productTerm.validFor | object | N | |
| product.productTerm.validFor.startDateTime | datetime | Start of current cycle period (latest period for which recurring processing has been attempted). | N |
| product.productTerm.validFor.endDateTime | datetime | End of current cycle period (latest period for which recurring processing has been attempted). | N |
| product.productTerm.@type | string | N | |
| product.productPrice | array | N | |
| product.productPrice.productOfferingPrice | object | N | |
| product.productPrice.productOfferingPrice.id | string | ID of product offer in pricing DB. | N |
| product.productPrice.productOfferingPrice.@type | string | Refarence of ProductOfferingPrice | N |
| product.productCharacteristic | array | Describes a given characteristic of an object or entity through a name/value pair.Note - Please refer Customer Characteristic below for more details | N |
| product.productCharacteristic.name | string | Name of the characteristic | N |
| product.productCharacteristic.value | any | The value of the characteristic | N |
| product.productCharacteristic.valueType | string | Data type of the value of the characteristic | N |
| product.productRelationship | array | N | |
| product.productRelationship.relationshipType | string | Name of the relationshipType as "Parent" | N |
| product.productRelationship.product | object | N | |
| product.productRelationship.product.id | string | If this purchased offer was purchased as part of a bundle, this field holds the resource ID of the bundle. Otherwise the value is zero (null). | N |
| product.productSpecification | object | A product specification reference | N |
| product.productSpecification.id | string | Commercial Plan Code | N |
| product.productSpecification.name | string | Commercial Plan Name | N |
| product.productSpecification.@type | string | Product specification type | N |
Characteristics Values:
| Name | Description | Sample |
|---|---|---|
| LastActivityTime | This value is used for determining lifecycle inactivity trigger(s). It represents the maximum of the LastActivityUpdateTime of the subscriber and the LastActivityUpdateTime for all of the associated devices unless excluding device activity for current status definition. This field is only updated by eligible activity while in a lifecycle state which features inactivity condition(s), when transitioning status, or when the LastActivityUpdateTime is explicitly modified. | { "name": "LastActivityTime", "value": "2022-03-22T13:27:06.000000Z" } |
| CurrentStatusTransitionTime | The time at which the subscription transitioned to the current status. | { "name": "CurrentStatusTransitionTime", "value": "2022-03-22T13:27:06.000000-04:00" } |
| UserCount | Number of users for this subscription. | { "name": "UserCount", "value": "1" } |
| statusId | status Id | { "name": "statusId", "value": "1" } |
| LLASubType | LLA SubType | { "name": "LLASubType", "value": "1" } |
product.Characteristics Values:
| Name | Description | Sample |
|---|---|---|
| CurrentStatusTransitionTime | The time at which the subscription transitioned to the current status. | { "name": "CurrentStatusTransitionTime", "value": "2022-03-22T09:27:06.000000-04:00" } |
| CycleModifyAllowed | If true, the cycle is configured to allow for modification. | { "name": "CycleModifyAllowed", "value": "false" } |
| OfferStatusDescription | Status description of the purchased offer. | { "name": "OfferStatusDescription", "value": "active" } |
| CatalogItemId | Catalog item ID in pricing DB, if associated with a catalog item. I.e., not for purchased offers which are part of a bundle. | { "name": "CatalogItemId", "value": "39" } |
| OfferType | Type of purchased offer. 1 = purchased_offer, 2 = purchased_bundle, 3 = bundle_purchased_offer Note - Mule API is doing logic, based on description making integer as string and passing to SF. | { "name": "OfferType", "value": "purchased_bundle" } |
| PrimaryBalanceResourceId | Resource ID of primary balance. | { "name": "PrimaryBalanceResourceId", "value": "1" } |
| AvailableAmount | The amount available to use based on the current active balance value. | { "name": "AvailableAmount", "value": 637.14 } |
| BalanceResourceId | Resource Id | { "name": "BalanceResourceId", "value": 1 } |
Possible Error Scenarios: :
IF WE ARE PASSING INVALID (publicIdentifier) IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "MATRIXX:PRODUCTINVENTORY_REPORT",
"description": "11 | Subscriber not found (AccessNumber=8919414206)"
}
]
}IF WE ARE PASSING INVALID (publicIdentifierType) IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "VALIDATION:MISMATCH",
"description": "PublicIdentifierType is not valid. Expected values are : SubscriptionId | MSISDN"
}
]
}IF WE ARE PASSING INVALID CHANNELID
{
"errors": [
{
"code": 501,
"message": "LLA:NOT_IMPLEMENTED",
"description": "There is no Implementation available for this BU"
}
]
}IF WE ARE PASSING INVALID SECURITY HEADERS
{
"error": "Invalid Client"
}