listScheduledOrdersByProfile
get
/ccstore/v1/scheduledOrders/current/scheduledOrders
List Scheduled Orders By Profile. It will return the list of all the scheduled orders for the current profile. Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.
Request
Supported Media Types
- application/json
Query Parameters
- limit
-
Type:
integer
limit of the scheduled orders list.- offset
Type:integer
Offset of the scheduled orders list.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listScheduledOrdersByProfile_response
- profileDetail
-
Type:
object
profileDetailThe details of the customer profile - scheduledOrderHistory
-
Type:
object
scheduledOrderHistoryList of scheduled orders for the customer profile including the pagination properties.
Nested Schema : profileDetail
Type:
object
The details of the customer profile
- daytimeTelephoneNumber
-
Type:
string
The day time telephone number of the customer profile. -
Type:
string
Email of the customer profile. - firstName
-
Type:
string
The first name of the customer profile. - id
-
Type:
string
The customer profile id. - lastName
-
Type:
string
Last name of the customer profile. - receiveEmail
-
Type:
string
Flag indicating whether the customer opted for receiving emails. - repositoryId
-
Type:
string
The repository id of the customer profile record. - shippingAddress
-
Type:
object
shippingAddressThe default shipping address for the customer profile
Nested Schema : scheduledOrderHistory
Type:
object
List of scheduled orders for the customer profile including the pagination properties.
- items
-
Type:
array
itemsList of scheduled orders for the customer profile. - limit
-
Type:
integer
The batch size of the scheduled order records fetched together. - offset
-
Type:
integer
The start index of the list of scheduled order records fetched. - total
-
Type:
integer
The total number of scheduled orders fetched. - totalResults
-
Type:
integer
The total number of scheduled orders fetched.
Nested Schema : shippingAddress
Type:
object
The default shipping address for the customer profile
- address1
-
Type:
string
The address line 1 in the shipping address. - address2
-
Type:
string
The address line 2 in the shipping address. - city
-
Type:
string
The city in the shipping address record. - country
-
Type:
string
The country in the shipping address record. - county
-
Type:
string
The county in the shipping address. - firstName
-
Type:
string
The first name in the shipping address. - lastName
-
Type:
string
The last name in the shipping address. - phoneNumber
-
Type:
string
The phone number in the shipping address. - postalCode
-
Type:
string
The postal code in the shipping address. - repositoryId
-
Type:
string
The repository id of the shipping address record. - state
-
Type:
string
The state in the shipping address.
Nested Schema : items
Nested Schema : items
Type:
object
- createDate
-
Type:
string
Scheduled Order creation date. - endDate
-
Type:
string
Scheduled order end date. - executionStatusList
-
Type:
array
executionStatusListThe list of executions from this scheduled order. - id
-
Type:
string
ID of the scheduled order. - lastScheduledRun
-
Type:
string
Last scheduled run date of the scheduled order. - name
-
Type:
string
Name of the Scheduled Order. - nextScheduledRun
-
Type:
string
Next scheduled run date of the scheduled order. - profileId
-
Type:
string
Profile ID of the shopper associated with the scheduled order. - repositoryId
-
Type:
string
Repository ID of the scheduled order. - schedule
-
Type:
object
scheduleSchedule of this scheduled order - startDate
-
Type:
string
Scheduled Order start date. - state
-
Type:
string
The state of the scheduled order. - templateOrderId
-
Type:
string
The template order id.
Nested Schema : executionStatusList
Nested Schema : schedule
Type:
object
Schedule of this scheduled order
- daysInMonth
-
Type:
array
daysInMonthDays in a month this scheduled order has to be placed - daysOfWeek
-
Type:
array
daysOfWeekDays in a week this scheduled order has to be placed - monthsInYear
-
Type:
array
monthsInYearMonths in a year this scheduled order has to be placed - occurrenceInDay
-
Type:
integer
The number of times this scheduled order is placed in a day - weeksInMonth
-
Type:
array
weeksInMonthWeeks in a month this scheduled order has to be placed
Nested Schema : items
Type:
object
- errorMessages
-
Type:
array
errorMessagesThe list of error messages for this execution. - executionDate
-
Type:
string
The execution date. - id
-
Type:
string
ID of the execution status. - orderId
-
Type:
string
Order ID of the order submitted in that particular execution. - orderSubmitted
-
Type:
boolean
The boolean indicating whether the order has been submitted successfully during the execution. - orderTotal
-
Type:
number
Order total. - repositoryId
-
Type:
string
The repository id of the execution status.
Nested Schema : errorMessages
Nested Schema : daysInMonth
Nested Schema : daysOfWeek
Nested Schema : monthsInYear
Nested Schema : weeksInMonth
Example 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
Body
Root Schema : errorModel
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAn optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code
Examples
Sample Response Payload returned by endpoint:
{ "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" } ] }