updateScheduledOrder
put
/ccstore/v1/scheduledOrders/{id}
Update Scheduled Order. It will update the scheduled order information like deactivate, change the schedule information. Optionally takes the X-CCOrganization header to specify current Organization context of logged in user .
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The id of the Scheduled order.
Header Parameters
-
X-CCOrganization: string
Current organization context of the logged in user
Root Schema : updateScheduledOrder_request
Type:
Show Source
object-
endDate:
string
Scheduled order end date.
-
name:
string
Name of the Scheduled Order.
-
schedule(required):
object schedule
The schedule of the scheduled order
-
startDate(required):
string
Scheduled Order start date.
-
state:
string
The state of the scheduled order.
Example:
{
"schedule":{
"daysInMonth":[
1
],
"weeksInMonth":[
],
"monthsInYear":[
1,
3,
5,
7,
9,
11
],
"daysOfWeek":[
],
"occurrenceInDay":1
},
"scheduleType":"calendar",
"endDate":"2016-12-08",
"name":"Monthly Order",
"state":"active",
"startDate":"2016-12-01"
}Nested Schema : schedule
Type:
objectThe schedule of the scheduled order
Show Source
-
daysInMonth:
array daysInMonth
Days in a month this scheduled order has to be placed
-
daysOfWeek:
array daysOfWeek
Days in a week this scheduled order has to be placed
-
delay:
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
monthsInYear:
array monthsInYear
Months in a year this scheduled order has to be placed
-
occurrenceInDay:
integer
The number of times this scheduled order is placed in a day
-
period:
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
weeksInMonth:
array weeksInMonth
Weeks in a month this scheduled order has to be placed
Nested Schema : daysInMonth
Type:
arrayDays in a month this scheduled order has to be placed
Show Source
Nested Schema : daysOfWeek
Type:
arrayDays in a week this scheduled order has to be placed
Show Source
Nested Schema : monthsInYear
Type:
arrayMonths in a year this scheduled order has to be placed
Show Source
Nested Schema : weeksInMonth
Type:
arrayWeeks in a month this scheduled order has to be placed
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateScheduledOrder_response
Type:
Show Source
object-
createDate:
string
Scheduled Order creation date.
-
endDate:
string
Scheduled order end date.
-
executionStatusList:
array executionStatusList
The list of executions from this scheduled order.
-
id:
string
ID of the scheduled order.
-
lastScheduledRun:
string
Last scheduled run date of the scheduled order.
-
name:
string
Name of the Scheduled Order.
-
nextScheduledRun:
string
Next scheduled run date of the scheduled order.
-
profileId:
string
Profile ID of the shopper associated with the scheduled order.
-
repositoryId:
string
Repository ID of the scheduled order.
-
schedule:
object schedule
Schedule of this scheduled order
-
startDate:
string
Scheduled Order start date.
-
state:
string
The state of the scheduled order.
-
templateOrderId:
string
The template order id.
Nested Schema : executionStatusList
Type:
arrayThe list of executions from this scheduled order.
Show Source
Nested Schema : schedule
Type:
objectSchedule of this scheduled order
Show Source
-
daysInMonth:
array daysInMonth
Days in a month this scheduled order has to be placed
-
daysOfWeek:
array daysOfWeek
Days in a week this scheduled order has to be placed
-
delay:
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
monthsInYear:
array monthsInYear
Months in a year this scheduled order has to be placed
-
occurrenceInDay:
integer
The number of times this scheduled order is placed in a day
-
period:
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
weeksInMonth:
array weeksInMonth
Weeks in a month this scheduled order has to be placed
Nested Schema : items
Type:
Show Source
object-
errorMessages:
array errorMessages
The list of error messages for this execution.
-
executionDate:
string
The execution date.
-
id:
string
ID of the execution status.
-
orderId:
string
Order ID of the order submitted in that particular execution.
-
orderSubmitted:
boolean
The boolean indicating whether the order has been submitted successfully during the execution.
-
orderTotal:
number
Order total.
-
repositoryId:
string
The repository id of the execution status.
Nested Schema : errorMessages
Type:
arrayThe list of error messages for this execution.
Show Source
Nested Schema : daysInMonth
Type:
arrayDays in a month this scheduled order has to be placed
Show Source
Nested Schema : daysOfWeek
Type:
arrayDays in a week this scheduled order has to be placed
Show Source
Nested Schema : monthsInYear
Type:
arrayMonths in a year this scheduled order has to be placed
Show Source
Nested Schema : weeksInMonth
Type:
arrayWeeks in a month this scheduled order has to be placed
Show Source
Example Response (application/json)
{
"schedule":{
"weeksInMonth":[
"1",
"2",
"3"
],
"monthsInYear":[
"1",
"2"
],
"daysOfWeek":[
"1",
"2",
"3"
]
},
"templateOrderId":"o10001",
"scheduleType":"calendar",
"endDate":"10/01/2017",
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"10/02/2015",
"Id":"sch001",
"state":"active",
"startDate":"10/01/2015",
"createDate":"9/01/2015"
}Default Response
The error response. In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response.
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code