Notify shipment completed
post
/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyShipmentCompleted
Notifies the completion of shipment in case of customer replacement or upgrade transaction.
Request
Path Parameters
-
TransactionNumber(required): string
The alternate unique identifier of the transaction.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
object
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Examples
The following example shows how to notify shipment completion 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/ATXN-2019
Example of Request Body
The following shows the contents of the request body in JSON format.
{ "name": "notifyShipmentCompleted", "parameters": [ ] }
Example of Response Body
The following shows the contents of the response body in JSON format.
{ "result": "SUCCESS" }