Update actual delivery date
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/action/updateActualDeliveryDate
Request
-
Metadata-Context: string
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: string
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.
- application/vnd.oracle.adf.action+json
object-
integrationContextCode: string
Indicates whether the request to update Actual Delivery Date comes from Oracle Fusion Cloud Transportation Management (use ORA_OTM_UPD_ACTUAL_DEL_DATE) or Oracle Fusion Cloud Shipping (ORA_UPDATE_ACTUAL_DEL_DATE).
-
processRequestOfflineAfter: number
Time, in seconds, after which the control is passed back to the calling client and the update actual delivery date attribute request continues in the background.
-
updateActualDeliveryDateRequest: array
updateActualDeliveryDateRequest
Required attributes for the Update Actual Delivery Date attribute request are DeliveryName, FulfillLineId, and ActualDeliveryDate.
array-
Array of:
object items
Additional Properties Allowed: additionalProperties
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
object-
result(required): array
result
The RequestStatus attribute in the Update actual delivery date response contains the status of the validation for the input parameters. It can have the values SUCCESS, ERROR, or PARTIALLY PROCESSED. In the case of an ERROR, the Message attribute contains the actual error message. In the case of SUCCESS, the Message attribute contains a message indicating that the request is being processed offline. In the case of PARTIALLY PROCESSED, the Message attribute contains error and success related information.
In addition to the RequestStatus and Message attributes, the response also contains DeliveryNumber, FulfillLineId, and ActualDeliveryDate
arrayIn addition to the RequestStatus and Message attributes, the response also contains DeliveryNumber, FulfillLineId, and ActualDeliveryDate
-
Array of:
object items
Additional Properties Allowed: additionalProperties
Examples
These examples describe how to update actual delivery dates.
| Example Number | Description |
|---|---|
| Example 1 | Update the actual delivery date from Oracle Fusion Cloud Shipping for a single order line. |
| Example 2 | Update the actual delivery date from Oracle Transportation Management for a single order line. |
| Example 3 | Update the actual delivery date from Oracle Fusion Cloud Shipping for multiple order lines. |
| Example 4 | Exception scenario: Duplicate call |
| Example 5 | Exception scenario: Wrong context |
| Example 6 | Exception scenario: Duplicate call when a request is still being processed |
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/action/updateActualDeliveryDate"
Example 1: Update the Actual Delivery Date from Shipping for a Single Order Line
This example shows you how to update the actual delivery date from Oracle Shipping for a single order line.
Example 1 Request Body
The following example includes the contents of the request body in JSON format to update the actual delivery date on a single order line from Shipping. In this example you can indicate the application as Shipping by setting the integration context code as ORA_UPDATE_ACTUAL_DEL_DATE. This ensures that the actual delivery date is updated for the fulfillment line ID and delivery number against the Shipment task type in doo_fulfill_line_details table. The processing of the request is done by a scheduled process.
You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies the attribute values that the command will use in the record that it updates.
{
"processRequestOfflineAfter": 1,
"integrationContextCode": "ORA_UPDATE_ACTUAL_DEL_DATE",
"updateActualDeliveryDateRequest": [
{
"FulfillLineIdentifier": "300100662753558",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"DeliveryName": "2777729"
}
]
}
Example 1 Response Body
The following example includes the contents of the response body in JSON format. The response indicates the schedule process request ID, which can be reviewed.
{
"result": [
{
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 710641 of the Process Responses from Order Fulfillment scheduled process.",
"RequestId": "710641"
},
{
"FulfillLineIdentifier": "300100662753558",
"DeliveryName": "2777729",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 710641 of the Process Responses from Order Fulfillment scheduled process."
}
]
}
Example 2: Update the Actual Delivery Date from Transportation Management for a Single Order Line
This example shows you how to update the actual delivery date on a single order line from Oracle Transportation Management.
Example 2 Request Body
The following example includes the contents of the request body in JSON format to update the actual delivery date on a single order line from Oracle Transportation Management. You can indicate the application as Oracle Transport Management by setting the integration context code as ORA_OTM_UPD_ACTUAL_DEL_DATE. This ensures that the actual delivery date is updated for the fulfillment line ID and delivery number against the DOO_TransportationPlanning task type in the doo_fulfill_line_details table. The processing of the request is done by a scheduled process.
You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies the attribute values that the command will use in the record that it updates.
{
"processRequestOfflineAfter": 1,
"integrationContextCode": "ORA_OTM_UPD_ACTUAL_DEL_DATE",
"updateActualDeliveryDateRequest": [
{
"FulfillLineIdentifier": "100105920118053",
"ActualDeliveryDate": "2024-11-02T18:00:00+00:00",
"DeliveryName": "2769718"
}
]
}
Example 2 Response Body
The following example includes the contents of the response body in JSON format. The response indicates the schedule process request ID, which can be reviewed.
{
"result": [
{
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 710682 of the Process Responses from Order Fulfillment scheduled process.",
"RequestId": "710682"
},
{
"FulfillLineIdentifier": "100105920118053",
"DeliveryName": "2769718",
"ActualDeliveryDate": "2024-11-02T18:00:00+00:00",
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 710682 of the Process Responses from Order Fulfillment scheduled process."
}
]
}
Example 3: Update the Actual Delivery Date from Shipping for Multiple Order Lines
This example shows you how to update the actual delivery date on multiple order lines from Oracle Shipping.
Example 3 Request Body
The following example includes the contents of the request body in JSON format to update the actual delivery date on multiple order lines from Shipping. In this example you can indicate the application as Shipping by setting the integration context code as ORA_UPDATE_ACTUAL_DEL_DATE. This ensures that the actual delivery date is updated for the fulfillment line ID and delivery number against the Shipment task type in doo_fulfill_line_details table. The processing of the request is done by a scheduled process.
You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"processRequestOfflineAfter": 1,
"integrationContextCode": "ORA_UPDATE_ACTUAL_DEL_DATE",
"updateActualDeliveryDateRequest": [
{
"FulfillLineIdentifier": "100105920286001",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"DeliveryName": "2772719"
},
{
"FulfillLineIdentifier": "100105920286000",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"DeliveryName": "2772719"
}
]
}
Example 3 Response Body
The following example includes the contents of the response body in JSON format. The response indicates the schedule process request ID, which can be reviewed.
{
"result": [
{
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 711372 of the Process Responses from Order Fulfillment scheduled process.",
"RequestId": "711372"
},
{
"FulfillLineIdentifier": "100105920286001",
"DeliveryName": "2772719",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 711372 of the Process Responses from Order Fulfillment scheduled process."
},
{
"FulfillLineIdentifier": "100105920286000",
"DeliveryName": "2772719",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"RequestStatus": "SUCCESS",
"Message": "REST API submitted your request to process the actual delivery date. See process ID 711372 of the Process Responses from Order Fulfillment scheduled process."
}
]
}
Example 4: Duplicate Call
This example shows you how to update the actual delivery date on multiple order lines from Shipping when the dates are already updated for them.
Example 4 Request Body
The following example includes the contents of the request body in JSON format. The payload includes data with actual delivery date on multiple order lines from Shipping when the dates are already updated for them. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"processRequestOfflineAfter": 1,
"integrationContextCode": "ORA_UPDATE_ACTUAL_DEL_DATE",
"updateActualDeliveryDateRequest": [
{
"FulfillLineIdentifier": "100105920286001",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"DeliveryName": "2772719"
},
{
"FulfillLineIdentifier": "100105920286000",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"DeliveryName": "2772719"
}
]
}
Example 4 Response Body
The following example includes the contents of the response body in JSON format. The response indicates the error message, indicating that the dates are already processed.
{
"result": [
{
"RequestStatus": "ERROR",
"Message": null
},
{
"FulfillLineIdentifier": "100105920286001",
"DeliveryName": "2772719",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"RequestStatus": "ERROR",
"Message": "You can't update the actual delivery date. Details: You can't update it because order management hasn't processed the shipment, already updated the actual delivery date, or the orchestration process isn't on a pause task."
},
{
"FulfillLineIdentifier": "100105920286000",
"DeliveryName": "2772719",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"RequestStatus": "ERROR",
"Message": "You can't update the actual delivery date. Details: You can't update it because order management hasn't processed the shipment, already updated the actual delivery date, or the orchestration process isn't on a pause task."
}
]
}
Example 5: Wrong Context
This example shows you how to update the actual delivery date when a REST call is made in the wrong context, for example, when a line doesn't have a transportation planning task.
Example 5 Request Body
The following example includes the contents of the request body in JSON format. The payload includes data to update the actual delivery date on a line with the integration context code as ORA_OTM_UPD_ACTUAL_DEL_DATE indicating that the request comes from transportation planning when the line doesn't have a transportation planning task.
You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"processRequestOfflineAfter": 1,
"integrationContextCode": "ORA_OTM_UPD_ACTUAL_DEL_DATE",
"updateActualDeliveryDateRequest": [
{
"FulfillLineIdentifier": "300100662753577",
"ActualDeliveryDate": "2024-11-02T18:00:00+00:00",
"DeliveryName": "2777729"
}
]
}
Example 5 Response Body
The following example includes the contents of the response body in JSON format. The response indicates the error message indicating that the transportation planning task does not exist in the orchestration process assigned to the line.
{
"result": [
{
"RequestStatus": "ERROR",
"Message": null
},
{
"FulfillLineIdentifier": "300100662753577",
"DeliveryName": "2777729",
"ActualDeliveryDate": "2024-11-02T18:00:00+00:00",
"RequestStatus": "ERROR",
"Message": "You can't update the ActualDeliveryDate attribute because the fulfillment line's transportation planning task isn't done or the line doesn't have that task. Details: If the line has the task, then wait for the task to finish, then resend your REST request."
}
]
}
Example 6: Duplicate Call When Request Is Still Being Processed
This example shows you how to update the actual delivery date when a REST call has already been submitted and is being processed when a second request is made for the same purpose.
Example 6 Request Body
The following example includes the contents of the request body in JSON format. The payload has the data for which the REST call was already submitted and before the completion of processing a second request is re-sent.
You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"processRequestOfflineAfter": 1,
"integrationContextCode": "ORA_UPDATE_ACTUAL_DEL_DATE",
"updateActualDeliveryDateRequest": [
{
"FulfillLineIdentifier": "300100662753577",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"DeliveryName": "2777729"
}
]
}
Example 6 Response Body
The following example includes the contents of the response body in JSON format. The response provides the error message.
{
"result": [
{
"RequestStatus": "ERROR",
"Message": null
},
{
"FulfillLineIdentifier": "300100662753577",
"DeliveryName": "2777729",
"ActualDeliveryDate": "2024-11-01T18:00:00+00:00",
"RequestStatus": "ERROR",
"Message": "Order management is currently processing another request to update the ActualDeliveryDate attribute for the same delivery on the fulfillment line. Details: You can't send a duplicate request."
}
]
}