Set the frequency of canceled order clean up

A service runs periodically to review the order repository and remove any orders that have been marked for cancellation because they exceeded the price hold period time limit.

This section applies to Open Storefront Framework (OSF) and Storefront Classic.

To set the initial frequency of the order cancellation service, you issue a POST request to the scheduledJobs endpoint, with a payload that defines the path to the CancelOrderScheduledJob component and the schedule, an example of which is provided below. To update the schedule, you issue a PUT request to the same endpoint.

POST /ccadmin/v1/merchant/scheduledJobs

{
"componentPath": "CancelOrderScheduledJob",
"scheduleType": "periodic",
"schedule":
  {
   "period" : 1000000
  }
}

The scheduleType and schedule properties determine the frequency used when running the service. Setting these properties is described in detail in the Configure the scheduled order service section.

See Set a price hold period for more information on the price hold period.