REST API for Oracle Commerce Cloud December 2017

createScheduledOrder

post

/ccstore/v1/scheduledOrders

Create Scheduled Order. Create the scheduledOrder based on existing order. Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.

Request

Supported Media Types

application/json

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

Body Parameter

Root Schema : createScheduledOrder_request

Example


{
    "schedule":{
        "selectedDates":[
        ],
        "weeksInMonth":[
            1,
            2,
            3
        ],
        "monthsInYear":[
            1,
            2
        ],
        "daysOfWeek":[
            1,
            2,
            3
        ]
    },
    "templateOrderId":"o0001",
    "scheduleType":"calendar",
    "endDate":"2017-10-01T00:00:00.000Z",
    "name":"testScheduleOrder",
    "startDate":"2015-10-01T00:00:00.000Z"
}

Properties

endDate: Type: string

The end date of the Scheduled order.
name: Type: string

Required: true

The name of the Scheduled order.
schedule: Type: object schedule

Required: true

Additional Properties Allowed:

The schedule of the Scheduled order.
scheduleType: Type: string

Required: true

The schedule type of the Scheduled order.
startDate: Type: string

Required: true

The start date of the Scheduled order.
templateOrderId: Type: string

Required: true

The template order id of the Scheduled order.

Nested Schema : schedule

Type: object

The schedule of the Scheduled order.

Properties

daysOfWeek: Type: array daysOfWeek

Required: true

Additional Properties Allowed:

The days of week of the Scheduled order.
interval: Type: integer

The interval in term of number of days of the Scheduled order.
monthsInYear: Type: array monthsInYear

Required: true

Additional Properties Allowed:

The months in year of the Scheduled order.
occurenceInDay: Type: integer

The occurence in day on the Scheduled order.
selectedDates: Type: array selectedDates

Required: true

Additional Properties Allowed:

The selected dates in a month in year for the Scheduled order.
weeksInMonth: Type: array weeksInMonth

Required: true

Additional Properties Allowed:

The weeks in month of the Scheduled order.

Nested Schema : daysOfWeek

Type: array

The days of week of the Scheduled order.

Items

Type: integer

Nested Schema : monthsInYear

Type: array

The months in year of the Scheduled order.

Items

Type: integer

Nested Schema : selectedDates

Type: array

The selected dates in a month in year for the Scheduled order.

Items

Type: integer

Nested Schema : weeksInMonth

Type: array

The weeks in month of the Scheduled order.

Items

Type: integer

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createScheduledOrder_response

Properties

createDate: Type: string

The create date of the Scheduled order.
endDate: Type: string

The end date of the Scheduled order.
id: Type: string

The id of the Scheduled order.
lastScheduledRun: Type: string

The last scheduled run of the Scheduled order.
name: Type: string

The name of the Scheduled order.
nextScheduledRun: Type: string

The next scheduled run of the Scheduled order.
profileId: Type: string

The profileId of the Scheduled order.
repositoryId: Type: string

The repository Id of the Scheduled order.
schedule: Type: object schedule

Additional Properties Allowed:

The schedule of the Scheduled order.
siteId: Type: string

The siteId of the Scheduled order.
startDate: Type: string

The start date of the Scheduled order.
state: Type: string

The status of the Scheduled order.
templateOrderId: Type: string

The templateOrderId of the Scheduled order.
type: Type: string

The type of the Scheduled order.
version: Type: integer

The version of the Scheduled order.

Nested Schema : schedule

Type: object

The schedule of the Scheduled order.

Properties

daysOfWeek: Type: array daysOfWeek

Additional Properties Allowed:

The days of week of the Scheduled order.
interval: Type: integer

The interval in term of number of days of the Scheduled order.
monthsInYear: Type: array monthsInYear

Additional Properties Allowed:

The months in year of the Scheduled order.
occurenceInDay: Type: integer

The occurence in day on the Scheduled order.
selectedDates: Type: array selectedDates

Additional Properties Allowed:

The selected dates in a month in year for the Scheduled order.
weeksInMonth: Type: array weeksInMonth

Additional Properties Allowed:

The weeks in month of the Scheduled order.

Nested Schema : daysOfWeek

Type: array

The days of week of the Scheduled order.

Items

Type: integer

Nested Schema : monthsInYear

Type: array

The months in year of the Scheduled order.

Items

Type: integer

Nested Schema : selectedDates

Type: array

The selected dates in a month in year for the Scheduled order.

Items

Type: integer

Nested Schema : weeksInMonth

Type: array

The weeks in month of the Scheduled order.

Items

Type: integer

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

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 errors

Additional Properties Allowed:

An 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

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

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 Request:

{
  "schedule": {
    "selectedDates": [],
    "weeksInMonth": [
      1,
      2,
      3
    ],
    "monthsInYear": [
      1,
      2
    ],
    "daysOfWeek": [
      1,
      2,
      3
    ]
  },
  "templateOrderId": "o0001",
  "scheduleType": "calendar",
  "endDate": "2017-10-01T00:00:00.000Z",
  "name": "testScheduleOrder",
  "startDate": "2015-10-01T00:00:00.000Z"
}