updateScheduledOrder

put

/ccstore/v1/scheduledOrders/{id}

Update Scheduled Order. It will update the scheduled order information like deactivate, change the schedule information. Optionally takes the X-CCOrganization header to specify current Organization context of logged in user .

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateScheduledOrder_request
Type: object
Show Source
Example:
{
    "schedule":{
        "daysInMonth":[
            1
        ],
        "weeksInMonth":[
        ],
        "monthsInYear":[
            1,
            3,
            5,
            7,
            9,
            11
        ],
        "daysOfWeek":[
        ],
        "occurrenceInDay":1
    },
    "scheduleType":"calendar",
    "endDate":"2016-12-08",
    "name":"Monthly Order",
    "state":"active",
    "startDate":"2016-12-01"
}
Nested Schema : schedule
Type: object
The schedule of the scheduled order
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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateScheduledOrder_response
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)
{
    "schedule":{
        "weeksInMonth":[
            "1",
            "2",
            "3"
        ],
        "monthsInYear":[
            "1",
            "2"
        ],
        "daysOfWeek":[
            "1",
            "2",
            "3"
        ]
    },
    "templateOrderId":"o10001",
    "scheduleType":"calendar",
    "endDate":"10/01/2017",
    "profileId":"user1",
    "name":"testScheduleOrder",
    "nextScheduledRun":"10/02/2015",
    "Id":"sch001",
    "state":"active",
    "startDate":"10/01/2015",
    "createDate":"9/01/2015"
}

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.
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