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

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
  • application/json
Path Parameters
id
Type: string
Required: true
The id of the Scheduled order.
Header Parameters
X-CCOrganization
Type: string
Current organization context of the logged in user
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

{
    "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
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": {
    "weeksInMonth": [
      "1",
      "2",
      "3"
    ],
    "monthsInYear": [
      "1",
      "2"
    ],
    "daysOfWeek": [
      "1",
      "2",
      "3"
    ]
  },
  "scheduleType": "calendar",
  "endDate": "10/01/2017",
  "name": "testScheduleOrder",
  "state": "active",
  "startDate": "10/01/2015"
}

Sample Response Payload returned by endpoint:

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