Page History

...

-Trouble Ticket API
-Product Ordering API
-Product Catalog API
-Usage Management API
-Product Inventory API
-Billing Management API
-Performance Management API
-Product Catalog API
-SLA Management API
-Customer Management API
-Party Management API

...

REQUEST

POST /orderManagement/productOrder

Content-type: application/json

{   "note":[
      {
         "text":"A free text detailing the note"
      }
   ],
   "relatedParty":[
      {
         "role":"customer",
         "id":"345221",
         "href":"http://serverlocation:port/partyManagement/customer/345221",
         "name":"John Doe"
      },
      {
         "role":"seller",
         "id":"4563",
         "href":"http://serverlocation:port/partnerManagement/partner/4563"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"add",
         "billingAccount":[{
               "id":"1789",
               "href":"http://serverlocation:port/billingManagement/billingAccount/1789"
         }],
         "productOffering":{
            "id":"42",
            "href":"http: //serverlocation: port/catalogManagement/productOffering/42"
         },
         "product":{
            "productCharacteristic":[
               {
                  "name":"Colour",
                  "value":"White"
               },
               {
                  "name":"Memory",
                  "value":"16"
               }
            ]
         }
      },
      {
         "id":"2",
         "action":"modify",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456",
            "relatedParty":[
               {
                  "role":"user",
                  "id":"5667443",
                  "href":"http://serverlocation:port/partyManagement/user/5667443",
                  "name":"Jimmy Doe"
               }
            ]
         }
      },
      {
         "id":"3",
         "action":"delete",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456"
         }
      }
   ]
}

RESPONSE

201

Content-Type: application/json

{
   "id":"42",
   "href":"http://serverlocation:port/orderManagement/productOrder/42",
   "priority":"4",
   "category":"uncategorized",
   "state":"Acknowledged",
   "orderDate":"2013-04-12T16:42:23-04:00",
   "expectedCompletionDate":"2013-04-19T16:42:23-04:00",   "note":[
      {
         "text":"A free text detailing the note"
      }
   ],
   "relatedParty":[
      {
         "role":"customer",
         "id":"345221",
         "href":"http://serverlocation:port/partyManagement/customer/345221"
         "name":"John Doe"
      },
      {
         "role":"seller",
         "id":"4563",
         "href":"http://serverlocation:port/partnerManagement/partner/4563"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"add",
         "state":"Acknowledged",
         "billingAccount":[{
               "id":"1789",
               "href":"http://serverlocation:port/billingManagement/billingAccount/1789"
         }],
         "productOffering":{
            "id":"42",
            "href":"http: //serverlocation: port/catalogManagement/productOffering/42"
         },
         "product":{
            "productCharacteristic":[
               {
                  "name":"Colour",
                  "value":"White"
               },
               {
                  "name":"Memory",
                  "value":"16"
               }
            ]
         }
      },
      {
         "id":"2",
         "action":"modify",
         "state":"Acknowledged",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456",
            "relatedParty":[
               {
                  "role":"user",
                  "id":"5667443",
                  "href":"http://serverlocation:port/partyManagement/user/5667443",
                  "name":"Jimmy Doe"
               }
            ]
         }
      },
      {
         "id":"3",
         "action":"delete",
         "state":"Acknowledged",
         "product":{
            "id":"456",
            "href":"http: //serverlocation: port/inventoryManagement/product/456"
         }
      }
   ]
}

Anchor
_Toc404092923
_Toc404092923
PRODUCT OFFERING RESOURCE MODEL

Managed Entity and Task Resource Models

Example of the JSON representation of a product offering:

{

"id": "42",

"href": "http://serverlocation:port/productCatalogManagement/productOffering/42",

"version": "2.0",

"lastUpdate": "2013-04-19T16:42:23.0Z",

"name": "Virtual Storage Medium",

"description": "Virtual Storage Medium",

"isBundle": true,

"lifecycleStatus": "Active",

"validFor":

{

"startDateTime": "2013-04-19T16:42:23.0Z",

"endDateTime": "2013-06-19T00:00:00.0Z"

},

"category":

[

{

"id": "12",

"href": "http://serverlocation:port/catalogManagement/category/12",

"version": "2.0",

"name": "Cloud offerings"

}

],

"channel":

[

{

"id": "13",

"href": "http://serverlocation:port/marketSales/channel/13",

"name": "Online Channel"

}

],

"place":

[

{

"id": "12",

"href": "http://serverlocation:port/marketSales/place/12",

"name": "France"

}

],

"bundledProductOffering":

[

{

"id": "15",

"href": "http://serverlocation:port/productCatalogManagement/productOffering/15",

"lifecycleStatus": "Active",

"name": "Offering 15"

},

{

"id": "64",

"href": "http://serverlocation:port/productCatalogManagement/productOffering/64",

"lifecycleStatus": "Active",

"name": "Offering 64"

}

],

"serviceLevelAgreement":

{

"id": "28",

"href": "http://serverlocation:port/slaManagement/serviceLevelAgreement/28",

"name": "Standard SLA"

},

"productSpecification":

{

"id": "13",

"href": "http://serverlocation:port/productCatalogManagement/productSpecification/13",

"version": "2.0",

"name": "specification product 1"

},

"serviceCandidate":

{

"id": "13",

"href": "http://serverlocation:port/serviceCatalogManagement/serviceCandidate/13",

"version": "2.0",

"name": "specification service 1"

},

"resourceCandidate":

{

"id": "13",

"href": "http://serverlocation:port/resourceCatalogManagement/resourceCandidate/13",

"version": "2.0",

"name": "specification resource 1"

},

"productOfferingTerm":

[

{

"name": "12 Month",

"description": "12 month contract",

"duration": "12",

"validFor":

{

"startDateTime": "2013-04-19T16:42:23.0Z",

"endDateTime": "2013-06-19T00:00:00.0Z"

}

],

"productOfferingPrice":

[

{

"name": "Monthly Price",

"description": "monthlyprice",

"validFor":

{

"startDateTime": "2013-04-19T16:42:23.0Z",

"endDateTime": "2013-06-19T00:00:00.0Z"

},

"priceType": "recurring",

"unitOfMeasure": "",

"price":

{

"taxIncludedAmount": 12,

"dutyFreeAmount": 10,

"taxRate": 20,

"currencyCode": "EUR",

"percentage": 0

},

"recurringChargePeriod": "monthly"

},

{

"name": "Usage Price",

"description": "usageprice",

"validFor":

{

"startDateTime": "2013-04-19T16:42:23.0Z",

"endDateTime": "2013-06-19T00:00:00.0Z"

},

"priceType": "usage",

"unitOfMeasure": "second",

"price":

{

"taxIncludedAmount": 12,

"dutyFreeAmount": 10,

"taxRate": 20,

"currencyCode": "EUR",

"percentage": 0

},

"recurringChargePeriod": "",

"productOfferPriceAlteration":

{

"name": "Shipping Discount",

"description": "One time shipping discount",

"validFor":

{

"startDateTime": "2013-04-19T16:42:23.0Z"

},

"priceType": "One Time discount",

"unitOfMeasure": "",

"price":

{

"percentage": 100

},

"recurringChargePeriod": "",

"priceCondition": "apply if total amount of the order is greater than 300.00"

}

]

}

Space shortcuts

Page tree

Versions Compared

Old Version 13

New Version 14

Key

Anchor
_Toc404092923
_Toc404092923
PRODUCT OFFERING RESOURCE MODEL

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 13

New Version 14

Key

Anchor_Toc404092923_Toc404092923PRODUCT OFFERING RESOURCE MODEL

Anchor
_Toc404092923
_Toc404092923
PRODUCT OFFERING RESOURCE MODEL