1. Oracle Commerce Cloud October 2017
  2. Tasks
  3. Store
  4. Scheduled Orders

getScheduledOrder

get

/ccstore/v1/scheduledOrders/{id}

Get Scheduled Order. It will return the scheduled order based on scheduled order id.Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.This endpoint returns the order details irrespective of organization ID passed in request header. If user doesn't belong to order's organization, then the user has no access to order.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The id of the Scheduled order.
Query Parameters
orderDetails
Type: boolean
Order Details of Scheduled Order.
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 : getScheduledOrder_response
Nested Schema : executionStatusList
Type: array
The list of executions from this scheduled order.
Nested Schema : schedule
Type: object
Schedule of this scheduled order
Nested Schema : templateOrder
Type: object
The template order details
Nested Schema : items
Type: object
Nested Schema : errorMessages
Type: array
The list of error messages for this execution.
Nested Schema : daysInMonth
Type: array
Days in a month this scheduled order has to be placed
Nested Schema : daysOfWeek
Type: array
Days in a week this scheduled order has to be placed
Nested Schema : monthsInYear
Type: array
Months in a year this scheduled order has to be placed
Nested Schema : weeksInMonth
Type: array
Weeks in a month this scheduled order has to be placed
Nested Schema : billingMethod
Type: object
billing Method information of the order.
Nested Schema : discountInfo
Type: object
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
gwpOrderMarker information
Nested Schema : orderComments
Type: array
The list of all logged comments for the order.
Nested Schema : paymentGroup
Type: object
Payment Group for the order.
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order.
Nested Schema : priceInfo
Type: object
Price information of the order.
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Nested Schema : profile
Type: object
Profile Information for the order.
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order.
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Nested Schema : shippingGroups
Type: array
Shipping Group Information
Nested Schema : shippingMethod
Type: object
Shipping method information.
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Nested Schema : orderCouponsMap
Type: array
Map of coupons.
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
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 : items
Type: object
Nested Schema : couponInfo
Type: array
The coupon Info.
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 : billingAddress
Type: object
Billing address for the order.
Nested Schema : items
Type: object
Nested Schema : billingAddress
Type: object
Billing address for the order.
Nested Schema : currency
Type: object
Currency of the PriceList group.
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Nested Schema : shippingMethod
Type: object
Shipping method information.
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Items in the cart.
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
Child items of the commerce item
Nested Schema : discountInfo
Type: object
Discount information.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Nested Schema : imageInfo
Type: object
Shipping method information.
Nested Schema : priceOverrideReason
Type: object
Price override reason map.
Nested Schema : variant
Type: array
Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : orderCouponsMap
Type: array
Map of coupons.
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : couponInfo
Type: array
The coupon Info.
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 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"
}