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
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

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