1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Agent
  4. Scheduled Orders

updateScheduledOrder

put

/ccagent/v1/scheduledOrders/{id}

Update Scheduled Order. Updates the scheduled order. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
ID of the scheduled order to be updated.
Header Parameters
X-CCOrganization
Type: string
The organization Id to which the order belongs
Body Parameter
Root Schema : updateScheduledOrder_request
Nested Schema : schedule
Type: object
The schedule of the Scheduled order.
Nested Schema : daysOfWeek
Type: array
The days of week of the Scheduled order.
Nested Schema : monthsInYear
Type: array
The months in year of the Scheduled order.
Nested Schema : selectedDates
Type: array
The selected dates in a month in year for the Scheduled order.
Nested Schema : weeksInMonth
Type: array
The weeks in month of the Scheduled order.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateScheduledOrder_response
Nested Schema : schedule
Type: object
The schedule of the Scheduled order.
Nested Schema : templateOrder
Type: object
The Order of the Scheduled order.
Nested Schema : daysOfWeek
Type: array
The days of week of the Scheduled order.
Nested Schema : monthsInYear
Type: array
The months in year of the Scheduled order.
Nested Schema : selectedDates
Type: array
The selected dates in a month in year for the Scheduled order.
Nested Schema : weeksInMonth
Type: array
The weeks in month of the Scheduled order.
Nested Schema : billingAddress
Type: object
The billing address details.
Nested Schema : discountInfo
Type: object
The discount information.
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Nested Schema : payments
Type: array
Payment details for the order, including additional properties specific to the payment type.
Nested Schema : priceInfo
Type: object
The price information.
Nested Schema : priceListGroup
Type: object
The price list group object.
Nested Schema : quoteInfo
Type: object
the quote information of the order
Nested Schema : shippingAddress
Type: object
The shipping address details.
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Nested Schema : shoppingCart/order
Type: object
The shopping-cart or order contents of the current order.
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Nested Schema : orderImplicitDiscountList
Type: array
The implicit order discounts with the order.
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Nested Schema : unclaimedCouponsMap
Type: object
The unclaimed coupons with the order.
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : items
Type: object
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : errorInfo
Type: array
the array of errors, if any
Nested Schema : notes
Type: array
the notes (history) for the order
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : discountInfo
Type: object
The shipping group price information.
Nested Schema : items
Type: array
The array of products in the shipping group.
Nested Schema : priceInfo
Type: object
The shipping group price information.
Nested Schema : shippingAddress
Type: object
The shipping address details.
Nested Schema : shippingMethod
Type: object
The shipping method details.
Nested Schema : taxPriceInfo
Type: object
The shipping tax price info details.
Nested Schema : discountDescList
Type: array
The list of all the order discounts.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : detailedItemPriceInfo
Type: object
Detailed Item Price Information.
Nested Schema : skuProperties
Type: array
Sku properties Information
Nested Schema : variant
Type: array
List of variants for the product.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: array
The array of products in the shopping cart.
Nested Schema : items
Type: object
Nested Schema : discountInfo
Type: array
The discount information.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Nested Schema : skuProperties
Type: array
Sku properties Information
Nested Schema : variant
Type: array
List of variants for the product.
Nested Schema : items
Type: object
Nested Schema : giftWithPurchaseDiscountInfo
Type: array
The gift information.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "lastError":null,
    "endDate":"2016-12-08T00:00:00.000Z",
    "executionStatusList":[
        {
            "errorMessages":[
                "Exception While cloning an order."
            ],
            "orderId":null,
            "repositoryId":"600005",
            "executionDate":"2016-11-23T00:00:00.000Z",
            "id":"600005",
            "orderSubmitted":false,
            "orderTotal":null
        }
    ],
    "type":"scheduledOrder",
    "version":25,
    "lastScheduledRun":"2016-11-23T00:00:00.000Z",
    "schedule":{
        "daysInMonth":[
        ],
        "weeksInMonth":[
        ],
        "monthsInYear":[
            1,
            3,
            5,
            7,
            9,
            11
        ],
        "daysOfWeek":[
        ],
        "occurrenceInDay":1
    },
    "templateOrderId":"o30414",
    "clonedOrders":[
    ],
    "profileId":"120939",
    "repositoryId":"sco10002",
    "name":"Monthly Order",
    "siteId":"siteUS",
    "nextScheduledRun":"1969-12-31T23:59:59.999Z",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/scheduledOrders/sco10002"
        }
    ],
    "state":"active",
    "id":"sco10002",
    "startDate":"2016-12-01T00:00:00.000Z",
    "createDate":"2016-11-21T11:15:15.000Z"
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100094|Organization passed in the header is currently inactive| |100095|The order or return request does not belong to the current organization of the shopper profile| |100096|The organization associated to the order or return request was deleted / does not exist| |100097|The organization associated to the order or return request is currently inactive| |100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization| |100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization| |100101|The shopper profile does not belong to organization passed in the header|
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 Request:

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

Sample Response Payload returned by endpoint:

{
  "lastError": null,
  "endDate": "2016-12-08T00:00:00.000Z",
  "executionStatusList": [{
    "errorMessages": ["Exception While cloning an order."],
    "orderId": null,
    "repositoryId": "600005",
    "executionDate": "2016-11-23T00:00:00.000Z",
    "id": "600005",
    "orderSubmitted": false,
    "orderTotal": null
  }],
  "type": "scheduledOrder",
  "version": 25,
  "lastScheduledRun": "2016-11-23T00:00:00.000Z",
  "schedule": {
    "daysInMonth": [],
    "weeksInMonth": [],
    "monthsInYear": [
      1,
      3,
      5,
      7,
      9,
      11
    ],
    "daysOfWeek": [],
    "occurrenceInDay": 1
  },
  "templateOrderId": "o30414",
  "clonedOrders": [],
  "profileId": "120939",
  "repositoryId": "sco10002",
  "name": "Monthly Order",
  "siteId": "siteUS",
  "nextScheduledRun": "1969-12-31T23:59:59.999Z",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/scheduledOrders/sco10002"
  }],
  "state": "active",
  "id": "sco10002",
  "startDate": "2016-12-01T00:00:00.000Z",
  "createDate": "2016-11-21T11:15:15.000Z"
}