REST API for Oracle Commerce Cloud December 2017

listExecutionStatusForScheduledOrderById

get

/ccstore/v1/scheduledOrders/status/{id}

List Execution Status For Scheduled Order By Id. It will list the execution status for a scheduled order . Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

The id of the Scheduled order.

Query Parameters

limit: Type: integer

limit of the scheduled orders list.
offset: Type: integer

Offset of the scheduled orders list.

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listExecutionStatusForScheduledOrderById_response

Properties

items: Type: array items

Additional Properties Allowed:

The array of the Scheduled orders by the id.
limit: Type: integer

The limit results of the Scheduled orders in a page.
offset: Type: integer

The offset results of the Scheduled orders.
total: Type: integer

The total number of the Scheduled orders.
totalResults: Type: integer

The total results of the Scheduled orders.

Nested Schema : items

Type: array

The array of the Scheduled orders by the id.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

endDate: Type: string

The end date of the Scheduled order.
executionStatusList: Type: array executionStatusList

Additional Properties Allowed:

The status list of executed scheduled orders
Id: Type: string

The Id of the Scheduled order.

Nested Schema : executionStatusList

Type: array

The status list of executed scheduled orders

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

errorMessages: Type: string

The error messages list.
executionDate: Type: string

The date for previous scheduled run
id: Type: string

The Id of the Scheduled order.
orderId: Type: string

The Id of the Scheduled order.
orderSubmitted: Type: boolean

The status of order.
orderTotal: Type: number

Total order value.
repositoryId: Type: string

The Id of the Scheduled order.
scheduledOrderId: Type: string

The Id of the Scheduled order.

Example application/json


{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstoreui/v1/scheduledOrders/status/sco20002"
        }
    ],
    "items":[
        {
            "scheduledOrderId":"sco20002",
            "errorMessages":[
                "hi this is error"
            ],
            "orderId":"o40414",
            "repositoryId":"0001",
            "executionDate":"2016-12-08T00:00:00.000Z",
            "id":"0001",
            "orderSubmitted":false,
            "orderTotal":123
        }
    ]
}

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 Response Payload returned by endpoint:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 250,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccstoreui/v1/scheduledOrders/status/sco20002"
  }],
  "items": [{
    "scheduledOrderId": "sco20002",
    "errorMessages": ["hi this is error"],
    "orderId": "o40414",
    "repositoryId": "0001",
    "executionDate": "2016-12-08T00:00:00.000Z",
    "id": "0001",
    "orderSubmitted": false,
    "orderTotal": 123
  }]
}