1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Asset Transactions

Create a subscription asset transaction

post

/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Asset Fulfillment Lines
Type: array
Title: Asset Fulfillment Lines
The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.
Show Source
Nested Schema : Asset Split Lines
Type: array
Title: Asset Split Lines
The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : subscriptionAssetTransactions-item-response
Type: object
Show Source
Nested Schema : Asset Fulfillment Lines
Type: array
Title: Asset Fulfillment Lines
The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.
Show Source
Nested Schema : Asset Split Lines
Type: array
Title: Asset Split Lines
The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.
Show Source
Nested Schema : subscriptionAssetTransactions-AssetFulfillmentLines-item-response
Type: object
Show Source
Nested Schema : subscriptionAssetTransactions-AssetSplitLines-item-response
Type: object
Show Source
Links
AssetFulfillmentLines
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.
AssetSplitLines
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.
notifyFulfillmentCompleted
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
This method will be used for notifying the completion of fulfillment in case of customer replacement or upgrade transaction.
notifyPendingFulfillmentCancelled
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
This method will be used for notifying the fulfillment is cancelled in case of customer replacement or upgrade transaction.
notifyReturnCompleted
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
This method will be used for notifying the completion of return in case of customer replacement or upgrade transaction.
notifyShipmentCompleted
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
Notifies the completion of shipment in case of customer replacement or upgrade transaction.
Back to Top

Examples

The following example shows how to create a subscription asset transaction by submitting a POST request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions

Example of Request Body

The following shows the contents of the request body in JSON format.

{
"TransactionType": "CUSTOMER_ASSET_CREATION",
"TransactionDate": "2020-07-01",  
"AssetId": 300100185258462,
"Quantity": 1,
"CustomerId": 1005,
"BillToAccountId": 1005,
"BillToAccountSiteUseId":1023,
"SalesOrderSystem": "CSV",
"SalesOrderId": "1000",
"SalesOrderLineId": 1000,
"SalesOrderNumber": "1",
"SalesOrderLineNumber": 1
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "TransactionId": 300100553691636,
    "TransactionNumber": "ATXN-3002",
    "TransactionSequence": 3001,
    "TransactionType": "CUSTOMER_ASSET_CREATION",
    "TransactionDate": "2020-07-01",
    "TransactionStatus": "PENDING",
    "AssetId": 300100185258462,
    "Quantity": 1,
    "BusinessUnitId": null,
    "CustomerId": 1005,
    "BillToAccountId": 1005,
    "BillToAccountSiteId": null,
    "BillToAccountSiteUseId": 1023,
    "ShipToPartyId": null,
    "ShipToPartySiteId": null,
    "SalesOrderSystem": "CSV",
    "SalesOrderId": 1000,
    "SalesOrderLineId": 1000,
    "SalesOrderNumber": "1",
    "SalesOrderLineNumber": "1",
    "ReturnOrderSystem": null,
    "ReturnOrderId": null,
    "ReturnOrderLineId": null,
    "ReturnOrderNumber": null,
    "ReturnOrderLineNumber": null,
    "ReplacementAssetId": null,
    "FulfillmentType": null,
    "WaitForFulfillment": null,
    "PendingFulfillmentCancelled": null,
    "ShipmentCompleted": null,
    "ReturnCompleted": null,
    "CreatedBy": "CONMGR",
    "CreationDate": "2021-03-09T06:02:06+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2021-03-09T06:02:06.783+00:00",
    "LastUpdateLogin": "BC547B379746472FE0530740F00AC04A",

...
}
Back to Top