Submitting a Mid-Term Upgrade Order via Connect API

Connect-only partners can place Mid-Term Upgrades via CloudBlue Connect API.

Note: Mid-Term upgrades will be supported in an upcoming CloudBlue Commerce release.

Change Order for Mid-term Upgrades

POST https://api.connect.cloudblue.com/public/v1/requests

Request Example

Copy
{
   "type":"change",
   "asset":{
      "id":"AS-6601-6298-4332",
      "product":{
         "id":"PRD-207-752-513"
      },
      "connection":{
         "id":"CT-9649-3123",
         "type":"test"
      },
      "items":[
         {
            "id":"PRD-207-752-513-00112",
            "quantity":2
         },
         {
            "id":"PRD-207-752-513-00143",
            "quantity":1
         }
      ],
      "params":[
         
      ],
      "tiers":{
         "customer":{
            "id":"TA-6125-5970-0769"
         },
         "tier1":{
            "id":"TA-2566-6792-4564"
         }
      }
   },
   "marketplace":{
      "id":"MP-65669"
   }
}

Note: Ensure that the key values are replaced with your own details (product ID, connection ID, connection type, marketplace ID, item IDs, asset ID, customer ID and tier 1 ID).

Mid-Term Upgrade Order Return

POST https://api.connect.cloudblue.com/public/v1/requests

Request Example

Copy
{
   "type":"change",
   "asset":{
      "id":"AS-6601-6298-4332",
      "product":{
         "id":"PRD-207-752-513"
      },
      "connection":{
         "id":"CT-9649-3123",
         "type":"test"
      },
      "items":[
         {
            "id":"PRD-207-752-513-00112",
            "quantity":3
         },
         {
            "id":"PRD-207-752-513-00143",
            "quantity":0
         }
      ],
      "params":[
         {
            "id":"is_cancellation_order",
            "value":"is-cancellation-request"
         },
         {
            "id":"cancel_order_id",
            "value":"P9202087005"
         }
      ],
      "tiers":{
         "customer":{
            "id":"TA-6125-5970-0769"
         },
         "tier1":{
            "id":"TA-2566-6792-4564"
         }
      }
   },
   "marketplace":{
      "id":"MP-65669"
   }
}

Note: For addition information on CloudBlue Connect API, refer to the CloudBlue Connect documentation.