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
Path Parameters
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getScheduledOrder_response
Type: object
Show Source
Nested Schema : executionStatusList
Type: array
The list of executions from this scheduled order.
Show Source
Nested Schema : schedule
Type: object
Schedule of this scheduled order
Show Source
Nested Schema : templateOrder
Type: object
The template order details
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : errorMessages
Type: array
The list of error messages for this execution.
Show Source
Nested Schema : daysInMonth
Type: array
Days in a month this scheduled order has to be placed
Show Source
Nested Schema : daysOfWeek
Type: array
Days in a week this scheduled order has to be placed
Show Source
Nested Schema : monthsInYear
Type: array
Months in a year this scheduled order has to be placed
Show Source
Nested Schema : weeksInMonth
Type: array
Weeks in a month this scheduled order has to be placed
Show Source
Nested Schema : billingMethod
Type: object
billing Method information of the order.
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gwpOrderMarker information
Show Source
Nested Schema : orderComments
Type: array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type: object
Payment Group for the order.
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order.
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Show Source
Nested Schema : profile
Type: object
Profile Information for the order.
Show Source
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingGroups
Type: array
Shipping Group Information
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Show Source
Nested Schema : orderCouponsMap
Type: array
Map of coupons.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponInfo
Type: array
The coupon Info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : currency
Type: object
Currency of the PriceList group.
Show Source
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : imageInfo
Type: object
Shipping method information.
Show Source
Nested Schema : priceOverrideReason
Type: object
Price override reason map.
Show Source
Nested Schema : variant
Type: array
Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : orderCouponsMap
Type: array
Map of coupons.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponInfo
Type: array
The coupon Info.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (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
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top