You are here:
Vlocity Order Management REST APIs
The following is a list of REST APIs usable for automated testing. Most controller methods in Salesforce are annotated with @RemoteAction, allowing JavaScript to call these methods from their respective classes, instead of the typical REST controllers commonly seen in RESTful applications.
As of the Winter '20 release, you should not use these APIs. Instead, use CPQ APIs to submit orders to Order Management: Cart-Based APIs for Industries CPQ
Class |
Method |
Description |
Original Controller Class |
HTTP Method |
REST URL |
Example Request Body |
|---|---|---|---|---|---|---|
XOMDecompositionREST |
isSfdcDecomposedOrder |
Returns boolean |
SimpleDecompositionController |
GET |
/services/apexrest/{namespacePrefix}/Decomposition/ isSfdcDecomposedOrder?orderId={orderId} |
|
decompose |
Returns string (OK/exception) |
POST |
/services/apexrest/{namespacePrefix}/Decomposition/ decompose?orderId={orderId} |
|||
decomposeAndCreatePlan |
Returns String (in json format) |
POST |
/services/apexrest/{namespacePrefix}/Decomposition/ decomposeAndCreatePlan?orderId={orderId} |
|||
viewDecomposition |
Returns String(OK/exception) |
GET |
/services/apexrest/{namespacePrefix}/Decomposition/ viewDecomposition?orderId={orderId} |
|||
viewDecomposedOrder |
returns JSON |
GET |
/services/apexrest/{namespacePrefix}/Decomposition/ viewDecomposedOrder?orderId={orderId} |
|||
getSourceOrderAssetInfo |
GET |
/services/apexrest/{namespacePrefix}/Decomposition/ getSourceOrderAssetInfo?orderId={orderId} |
||||
getMappingDetails |
POST |
/services/apexrest/{namespacePrefix}/Decomposition/ getMappingDetails?offPlatformMode={true/false} |
List of comma separated specIds, for example: 01t6A000002SZm2QAG, 01t6A000002SZlxQAG |
|||
thorInfo |
POST |
/services/apexrest/{namespacePrefix}/Decomposition/thorInfo?orderId={orderId}&offPlatformMode={true/false} |
JSON Order |
|||
isOffPlatform |
GET |
/services/apexrest/{namespacePrefix}/Decomposition/isOffPlatform |
||||
RestAccountResource |
inventoryitems |
XOMFRLineAndInventoryItemController |
GET |
/services/apexrest/{namespacePrefix}/v1/accounts/{accountId} |
||
XOMOrchestrationScenarioREST |
getOrchestrationPlanId |
Returns planId string |
OrchestrationPlanViewController |
GET |
/services/apexrest/{namespacePrefix}/Orchestration/ getOrchestrationPlanId?orderId={orderId} |
|
getOrchestrationPlan |
Returns OrchestrationPlanView |
OrchestrationPlanControllerExtension |
GET |
/services/apexrest/{namespacePrefix}/Orchestration/ getOrchestrationPlan?planId={planId} |
||
getOrchestrationPlanItem |
Returns OrchestrationItemView |
GET |
/services/apexrest/{namespacePrefix}/Orchestration/ getOrchestrationItem?itemId={itemId} |
|||
executeTask |
Returns a map<input string, output String> |
ManualTaskExecutionController |
POST |
/services/apexrest/{namespacePrefix}/ Orchestration/executeTask |
{ "loggedUserId" : "{loggedUserId}", "AssignedToUser" : "{AssignedToUser}", "ContextId" : "{ContextId}", "toBeTaskState" : "{toBeTaskState}", "userSelectedAction" : "{userSelectedAction}" } |
