sgo-ux

sgo-ux is the new experience layer for SGO channel (Sistema de Gestion de Ordenes). For Panama uses.

The base URI is : https://host:port/sgo-ux/v1/{businessId}

Below given uses cases are implemented with the mentioned resources under

UseCase wise resources

get Handset subsidy --> /promotion(GET)

Detect Active Subsidy --> /activeSubsidy/{id} (GET)

Get Pricing Plans --> /productOfferings (GET)

Get Secondary Products Available for Sale --> /secondaryProducts (GET)

Fetch spare Service Number --> /logicalResource (GET)

Reserve Service Number --> /logicalResource (PATCH)

Release Service Number --> /logicalResource (PATCH)

Load MacInventory Details --> /logicalResource (POST)

Search SIM Number --> /physicalResource/{id} (GET)

Reserve SIM Number --> /physicalResource (PATCH)

Release SIM Number --> /physicalResource (PATCH)

Get Products By Service Account --> /productsForServiceAccount (GET)

Get Employee Details --> /employee (GET)

getArea --> /area (GET)

Get Billing Account By Type/Id --> /billingAccount/{id} (GET)

Fetch Packages --> /catalog (GET)

Package By Id --> /catalog/{id} (GET)

List Services --> /service (GET)

Unpaid Invoice --> /invoice (GET)

Post Product Order --> /productOrder (POST)

create Customer --> /customer (POST)

Get Products --> /products (GET)

Get Pricing plans --> /pricingPlans (GET)

Get Priding plans by id --> /pricingPlans/{id} (GET)

Get Services Inventory --> /services/inventory (GET)

GET Account Rentals By Id --> /accounts/{accountNo}/rentals (GET)

List Provinces --> /province (GET)

List Suburbs --> /suburb (GET)

List Counties --> /county (GET)

List Districts --> /district (GET)

List Fixed Address Details --> /fixedAddressDetails (GET)

POST: /productOrder (IT-14132 - TradeIn Functionality)

TradeIn functionality helps in enabling tradeIn for postpaid products.
1. New fields handsetBrand, handsetModel, tradeInIndicator & tradeInAmount are the new fields added as part of the existing request.
2. TradeIn scope is applicable only for B2C Customers for mobile provisioning with commandId PCH for Handset products.
3. tradeInIndicator will be Y from SGO after validation of BU Params PAN_SUBDY_DETS_DISP & PAN_TRADEIN_PAYMENT. No additional calls required from ESB end for validation of BU Params.
4. SGO to send tradeInAmount post all calculations in tradeInAmount field which will be sent in prfgroup to liberate.
5. chargeToBill value is sent as per existing functionality under ItemPrice.price.taxIncludedAmount.

ProductOrder Request

{
  "billingAccount": {
    "id": "322473410000"
  },
  "productOrderItem": [
    {
      "action": "add",
      "product": {
        "isBundle": false,
        "productCharacteristic": [
          {
            "name": "simSerialPrefix",
            "valueType": "string",
            "value": "8950701"
          },
          {
            "name": "simCardNo",
            "valueType": "string",
            "value": "0050312033138"
          },
          {
            "name": "MSISDN",
            "valueType": "string",
            "value": "66549892"
          }
        ],
        "@type": "Package"
      },
      "@type": "ProductOrderItem",
      "id": "MP_1186",
      "quantity": 1
    },
    {
      "id": "190046",
      "quantity": 1,
      "action": "add",
      "product": {
        "isBundle": false,
        "productCharacteristic": [
          {
            "valueType": "string",
            "value": "PCH",
            "name": "commandID"
          }
        ],
        "@type": "GenericAddonProduct"
      },
      "productOrderItemRelationship": [
        {
          "id": "MP_1186",
          "relationshipType": "Parent"
        }
      ],
      "@type": "ProductOrderItem"
    },
    {
      "action": "add",
      "product": {
        "isBundle": false,
        "@type": "Plan"
      },
      "productOrderItemRelationship": [
        {
          "id": "MP_1186",
          "relationshipType": "Parent"
        }
      ],
      "@type": "ProductOrderItem",
      "id": "MD_4149",
      "quantity": 1
    },
    {
      "quantity": 1,
      "action": "add",
      "productOrderItemRelationship": [
        {
          "id": "MP_1186",
          "relationshipType": "Parent"
        }
      ],
      "itemPrice": [
        {
          "name": "salePrice",
          "priceType": "sold",
          "price": {
            "taxIncludedAmount": {
              "value": 0
            }
          }
        },
        {
          "name": "deposit",
          "price": {
            "taxIncludedAmount": {
              "value": 0
            }
          }
        }
      ],
      "product": {
        "productCharacteristic": [
          {
            "name": "deviceID",
            "valueType": "string",
            "value": ""
          },
          {
            "name": "commandID",
            "valueType": "string",
            "value": "PCH"
          },
          {
            "name": "promoCode",
            "valueType": "string",
            "value": ""
          },
          {
            "name": "imei",
            "valueType": "string",
            "value": "111111111111111"
          },
          {
            "name": "handsetBrand",
            "valueType": "string",
            "value": "IPHONE"
          },
          {
            "name": "handsetModel",
            "valueType": "string",
            "value": "16PROMAX"
          },
          {
            "name": "tradeInAmount",
            "valueType": "string",
            "value": "0"
          },
          {
            "name": "tradeInIndicator",
            "valueType": "string",
            "value": "Y"
          },
          {
            "value": 0,
            "name": "additionalDiscount",
            "valueType": "integer"
          },
          {
            "value": 0,
            "name": "saleDiscount",
            "valueType": "integer"
          },
          {
            "name": "contractDuration",
            "valueType": "integer",
            "value": 18
          },
          {
            "name": "customerOwned",
            "value": "Y"
          },
          {
            "name": "optForInstallment",
            "valueType": "string",
            "value": "N"
          },
          {
            "name": "upfrontPayment",
            "valueType": "string",
            "value": "0"
          }
        ],
        "@type": "Handset",
        "isBundle": false
      },
      "@type": "ProductOrderItem",
      "id": "101044"
    }
  ],
  "orderCharacteristics": {
    "numberAreaCode": "MOV",
    "orderType": "prepaid_to_postpaid_int_port",
    "contractId": "2027211",
    "salesRepId": "92638",
    "depttCode": "MOVIL",
    "siteCode": "GSM",
    "sourceOfApplication": "EH",
    "exchangeId": "GSMM",
    "servicePin": "1234",
    "cisEmpId": "92638",
    "donornetwork": "CWP",
    "prepaidToPostpaidSamesim": "Y",
    "serNumberStatus": "RESERVED"
  },
  "serviceAddress": {
    "addrType": "Q",
    "addrLine1": "Principal",
    "addrLine2": "BARRIADA SANTA ISABEL                   ",
    "addrLine3": "CHEPO                                   ",
    "addrLine4": "CHEPO                                   ",
    "addrLine5": "PANAMA                                  "
  }
}