listScheduledOrders
get
/ccstore/v1/scheduledOrders
This endpoints returns list of all scheduled orders which can be accessed by current logged-in user. Optionally takes the X-CCOrganization header to specify current Organization context of logged-in user.
Request
Supported Media Types
- application/json
Query Parameters
-
limit: integer
limit of the scheduled orders list.
-
offset: integer
Offset of the scheduled orders list.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listScheduledOrdersByProfile_response
Type:
Show Source
object-
profileDetail:
object profileDetail
The details of the customer profile
-
scheduledOrderHistory:
object scheduledOrderHistory
List of scheduled orders for the customer profile including the pagination properties.
Nested Schema : profileDetail
Type:
objectThe details of the customer profile
Show Source
-
dateOfBirth:
string
Date of birth
-
daytimeTelephoneNumber:
string
The day time telephone number of the customer profile.
-
email:
string
Email of the customer profile.
-
firstName:
string
The first name of the customer profile.
-
id:
string
The customer profile id.
-
lastName:
string
Last name of the customer profile.
-
locale:
string
Current Locale
-
receiveEmail:
string
Flag indicating whether the customer opted for receiving emails.
-
repositoryId:
string
The repository id of the customer profile record.
-
shippingAddress:
object shippingAddress
The default shipping address for the customer profile
Nested Schema : scheduledOrderHistory
Type:
objectList of scheduled orders for the customer profile including the pagination properties.
Show Source
-
items:
array items
List of scheduled orders for the customer profile.
-
limit:
integer
The batch size of the scheduled order records fetched together.
-
offset:
integer
The start index of the list of scheduled order records fetched.
-
total:
integer
The total number of scheduled orders fetched.
-
totalResults:
integer
The total number of scheduled orders fetched.
Nested Schema : shippingAddress
Type:
objectThe default shipping address for the customer profile
Show Source
-
address1:
string
The address line 1 in the shipping address.
-
address2:
string
The address line 2 in the shipping address.
-
city:
string
The city in the shipping address record.
-
country:
string
The country in the shipping address record.
-
county:
string
The county in the shipping address.
-
firstName:
string
The first name in the shipping address.
-
lastName:
string
The last name in the shipping address.
-
phoneNumber:
string
The phone number in the shipping address.
-
postalCode:
string
The postal code in the shipping address.
-
repositoryId:
string
The repository id of the shipping address record.
-
state:
string
The state in the shipping address.
Nested Schema : items
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)
{
"total":2,
"totalResults":2,
"offset":20,
"limit":10,
"items":[
{
"templateOrderId":"o10001",
"endDate":"10/01/2015",
"templateOrder":{
"state":"TEMPLATE"
},
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"10/02/2015",
"Id":"sch001",
"state":"inactive",
"startDate":"10/01/2015"
},
{
"templateOrderId":"o10001",
"endDate":"10/01/2018",
"templateOrder":{
"state":"PENDING_APPROVAL_TEMPLATE"
},
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"10/02/2017",
"Id":"sch002",
"state":"active",
"startDate":"10/01/2015"
},
{
"templateOrderId":"o10002",
"endDate":"10/01/2017",
"templateOrder":{
"state":"PENDING_PAYMENT_TEMPLATE"
},
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"01/02/2017",
"Id":"sch003",
"state":"active",
"startDate":"10/01/2015"
}
]
}Default Response
The 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