1. Oracle Commerce Cloud October 2017
  2. Tasks
  3. Store
  4. Scheduled Orders

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
Nested Schema : profileDetail
Type: object
The details of the customer profile
Nested Schema : scheduledOrderHistory
Type: object
List of scheduled orders for the customer profile including the pagination properties.
Nested Schema : shippingAddress
Type: object
The default shipping address for the customer profile
Nested Schema : items
Type: array
List of scheduled orders for the customer profile.
Nested Schema : items
Type: object
Nested Schema : executionStatusList
Type: array
The list of executions from this scheduled order.
Nested Schema : schedule
Type: object
Schedule of this scheduled order
Nested Schema : items
Type: object
Nested Schema : errorMessages
Type: array
The list of error messages for this execution.
Nested Schema : daysInMonth
Type: array
Days in a month this scheduled order has to be placed
Nested Schema : daysOfWeek
Type: array
Days in a week this scheduled order has to be placed
Nested Schema : monthsInYear
Type: array
Months in a year this scheduled order has to be placed
Nested Schema : weeksInMonth
Type: array
Weeks in a month this scheduled order has to be placed
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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

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"
    }
  ]
}