createScheduledOrder
post
/ccstore/v1/scheduledOrders
Create Scheduled Order. Create the scheduledOrder based on existing order. Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Root Schema : createScheduledOrder_request
Type:
Show Source
object-
endDate(optional):
string
The end date of the Scheduled order.
-
name:
string
The name of the Scheduled order.
-
schedule:
object schedule
The schedule of the Scheduled order.
-
scheduleType:
string
The schedule type of the Scheduled order.
-
startDate:
string
The start date of the Scheduled order.
-
templateOrderId:
string
The template order id of the Scheduled order.
Example:
{
"schedule":{
"selectedDates":[
],
"weeksInMonth":[
1,
2,
3
],
"monthsInYear":[
1,
2
],
"daysOfWeek":[
1,
2,
3
]
},
"templateOrderId":"o0001",
"scheduleType":"calendar",
"endDate":"2017-10-01T00:00:00.000Z",
"name":"testScheduleOrder",
"startDate":"2015-10-01T00:00:00.000Z"
}Nested Schema : schedule
Type:
objectThe schedule of the Scheduled order.
Show Source
-
daysOfWeek:
array daysOfWeek
The days of week of the Scheduled order.
-
delay(optional):
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
interval(optional):
integer
The interval in term of number of days of the Scheduled order.
-
monthsInYear:
array monthsInYear
The months in year of the Scheduled order.
-
occurenceInDay(optional):
integer
The occurence in day on the Scheduled order.
-
period:
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
selectedDates:
array selectedDates
The selected dates in a month in year for the Scheduled order.
-
weeksInMonth:
array weeksInMonth
The weeks in month of the Scheduled order.
Nested Schema : selectedDates
Type:
arrayThe selected dates in a month in year for the Scheduled order.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createScheduledOrder_response
Type:
Show Source
object-
createDate(optional):
string
The create date of the Scheduled order.
-
endDate(optional):
string
The end date of the Scheduled order.
-
id(optional):
string
The id of the Scheduled order.
-
lastScheduledRun(optional):
string
The last scheduled run of the Scheduled order.
-
name(optional):
string
The name of the Scheduled order.
-
nextScheduledRun(optional):
string
The next scheduled run of the Scheduled order.
-
profileId(optional):
string
The profileId of the Scheduled order.
-
repositoryId(optional):
string
The repository Id of the Scheduled order.
-
schedule(optional):
object schedule
The schedule of the Scheduled order.
-
siteId(optional):
string
The siteId of the Scheduled order.
-
startDate(optional):
string
The start date of the Scheduled order.
-
state(optional):
string
The status of the Scheduled order.
-
templateOrderId(optional):
string
The templateOrderId of the Scheduled order.
-
type(optional):
string
The type of the Scheduled order.
-
version(optional):
integer
The version of the Scheduled order.
Nested Schema : schedule
Type:
objectThe schedule of the Scheduled order.
Show Source
-
daysOfWeek(optional):
array daysOfWeek
The days of week of the Scheduled order.
-
delay(optional):
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
interval(optional):
integer
The interval in term of number of days of the Scheduled order.
-
monthsInYear(optional):
array monthsInYear
The months in year of the Scheduled order.
-
occurenceInDay(optional):
integer
The occurence in day on the Scheduled order.
-
period(optional):
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
selectedDates(optional):
array selectedDates
The selected dates in a month in year for the Scheduled order.
-
weeksInMonth(optional):
array weeksInMonth
The weeks in month of the Scheduled order.
Nested Schema : selectedDates
Type:
arrayThe selected dates in a month in year for the Scheduled order.
Show Source
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(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
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(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code