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

getIncompleteOrder

get

/ccstore/v1/orders/current

Get Incomplete Order. Returns incomplete order of the logged-in user. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types
  • application/json
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 : getIncompleteOrder_response
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 : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information.
Nested Schema : priceInfo
Type: object
Price information of the order.
Nested Schema : priceListGroup
Type: object
The price list group object.
Nested Schema : quoteInfo
Type: object
the quote information of the order
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Nested Schema : shippingMethod
Type: object
Shipping Method information of the order.
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Nested Schema : orderCouponsMap
Type: object
The coupons that were claimed
Nested Schema : orderImplicitDiscountList
Type: array
Implicit Promotions for the order
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Nested Schema : unclaimedCouponsMap
Type: object
The coupons that were not claimed
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
Nested Schema : items
Type: object
Nested Schema : coupon code
Type: object
Coupon Code
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: object
Coupon Code
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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: array
The array of products in the shipping group.
Nested Schema : shippingAddress
Type: object
The shipping address details.
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Nested Schema : items
Type: object
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
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: object
Nested Schema : items
Type: array
Items in the cart.
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
giftWithPurchaseCommerceItemMarker 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 : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "priceInfo":{
        "amount":1432,
        "total":1432,
        "shipping":0,
        "shippingSurchargeValue":0,
        "tax":0,
        "subTotal":1432,
        "currencyCode":"USD"
    },
    "shippingGroups":[
        {
            "priceInfo":{
                "amount":1432,
                "total":1432,
                "shipping":0,
                "shippingSurchargeValue":0,
                "tax":0,
                "subTotal":1432,
                "currencyCode":"USD",
                "totalWithoutTax":1432
            },
            "recurringChargePriceInfo":{
                "amount":30,
                "total":32.4,
                "shipping":0,
                "subTotalByFrequency":[
                    {
                        "amount":30,
                        "frequency":"Monthly"
                    }
                ],
                "taxByFrequency":[
                    {
                        "amount":2.4,
                        "frequency":"Monthly"
                    }
                ],
                "tax":2.4,
                "subTotal":30,
                "currencyCode":"USD",
                "totalWithoutTax":30
            },
            "discountInfo":{
                "orderDiscount":0,
                "shippingDiscount":0,
                "discountDescList":[
                ]
            },
            "shippingMethod":{
                "shippingTax":0,
                "cost":0,
                "value":"hardgoodShippingGroup",
                "shippingMethodDescription":"hardgoodShippingGroup"
            },
            "shippingGroupId":"sg10038",
            "shippingAddress":{
                "lastName":null,
                "country":null,
                "address3":null,
                "address2":null,
                "city":null,
                "address1":null,
                "prefix":null,
                "companyName":null,
                "postalCode":null,
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "firstName":null,
                "phoneNumber":null,
                "alias":null,
                "faxNumber":null,
                "middleName":null,
                "state":null,
                "email":null
            },
            "items":[
                {
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":1432,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "commerceItemId":"ci3000411",
                    "assetId":"asset10001",
                    "price":1432,
                    "variant":[
                        {
                            "optionValue":"Blue",
                            "optionName":"Color"
                        },
                        {
                            "optionValue":"Medium",
                            "optionName":"Size"
                        }
                    ],
                    "onSale":false,
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "unitPrice":179,
                    "serviceAccountId":"serviceAcc-123",
                    "quantity":8,
                    "productId":"xprod2148",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":1432,
                            "quantity":8,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":179,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "externalRecurringChargeFrequency":"Monthly",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"xsku2148",
                    "skuProperties":[
                        {
                            "propertyType":"sku-base",
                            "name":"UPC Code",
                            "id":"upcCode",
                            "value":"123456"
                        }
                    ],
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "listPrice":179,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ]
        }
    ],
    "recurringChargePriceInfo":{
        "amount":30,
        "total":32.4,
        "shipping":0,
        "subTotalByFrequency":[
            {
                "amount":30,
                "frequency":"Monthly"
            }
        ],
        "taxByFrequency":[
            {
                "amount":2.4,
                "frequency":"Monthly"
            }
        ],
        "tax":2.4,
        "subTotal":30,
        "currencyCode":"USD",
        "totalWithoutTax":30
    },
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "promotionDesc":"promo4",
                    "promotionId":"promo20004"
                }
            ]
        },
        "orderCouponsMap":{
            "coupon1":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo1",
                "promotionId":"promo20001"
            },
            "coupon2":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo2",
                "promotionId":"promo20002"
            }
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
            {
                "promotionLevel":"item",
                "totalAdjustment":"-0.66",
                "promotionDesc":"Implicit Item Discount - 3PercentOff",
                "promotionId":"implicitItemPercentDiscount"
            }
        ],
        "claimedCouponMultiPromotions":{
            "coupon1":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo1",
                    "promotionId":"promo20001"
                },
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo3",
                    "promotionId":"promo20003"
                }
            ],
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo2",
                    "promotionId":"promo20002"
                }
            ]
        },
        "unclaimedCouponsMap":{
            "coupon2":{
                "promotionLevel":"order",
                "promotionDesc":"promo4",
                "promotionId":"promo20004"
            }
        }
    },
    "orderId":"o10002",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "shippingMethod":{
        "cost":0,
        "value":"hardgoodShippingGroup"
    },
    "shoppingCart":{
        "numberOfItems":8,
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "commerceItemId":"ci3000411",
                "assetId":"asset10001",
                "price":1432,
                "variant":[
                    {
                        "optionValue":"Blue",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Medium",
                        "optionName":"Size"
                    }
                ],
                "onSale":false,
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":179,
                "serviceAccountId":"serviceAcc-123",
                "quantity":8,
                "productId":"xprod2148",
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "externalRecurringChargeFrequency":"Monthly",
                "catRefId":"xsku2148",
                "externalRecurringChargeDuration":"12",
                "skuProperties":[
                    {
                        "propertyType":"sku-base",
                        "name":"UPC Code",
                        "id":"upcCode",
                        "value":"123456"
                    }
                ],
                "customerAccountId":"customerAcc-123",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "recurringCharge":10
            }
        ]
    },
    "priceListGroup":{
        "repositoryId":"UsDollar"
    },
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "profileType":null,
                "profileId":"120213",
                "requestDate":1.477479521002E12,
                "requesterNote":"This is a sample quote"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-26T10:58:41.002Z",
        "errorInfo":null,
        "externalID":null,
        "rejectionNote":null,
        "quoteDate":null,
        "expirationDate":null
    },
    "giftWithPurchaseOrderMarkers":[
        {
            "quantity":1,
            "selectedQuantity":0,
            "removedQuantity":0,
            "data":"-1275480226",
            "automaticQuantity":0,
            "giftType":"product",
            "autoRemove":true,
            "giftDetail":"camera_1",
            "repositoryId":"200001",
            "failedQuantity":0,
            "value":"promo10002",
            "targetedQuantity":0,
            "key":"atg.gwp"
        }
    ]
}
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:

{
  "priceInfo": {
    "amount": 1432,
    "total": 1432,
    "shipping": 0,
    "shippingSurchargeValue": 0,
    "tax": 0,
    "subTotal": 1432,
    "currencyCode": "USD"
  },
  "shippingGroups": [{
    "priceInfo": {
      "amount": 1432,
      "total": 1432,
      "shipping": 0,
      "shippingSurchargeValue": 0,
      "tax": 0,
      "subTotal": 1432,
      "currencyCode": "USD",
      "totalWithoutTax": 1432
    },
    "recurringChargePriceInfo": {
      "amount": 30,
      "total": 32.4,
      "shipping": 0,
      "subTotalByFrequency": [{
        "amount": 30,
        "frequency": "Monthly"
      }],
      "taxByFrequency": [{
        "amount": 2.4,
        "frequency": "Monthly"
      }],
      "tax": 2.4,
      "subTotal": 30,
      "currencyCode": "USD",
      "totalWithoutTax": 30
    },
    "discountInfo": {
      "orderDiscount": 0,
      "shippingDiscount": 0,
      "discountDescList": []
    },
    "shippingMethod": {
      "shippingTax": 0,
      "cost": 0,
      "value": "hardgoodShippingGroup",
      "shippingMethodDescription": "hardgoodShippingGroup"
    },
    "shippingGroupId": "sg10038",
    "shippingAddress": {
      "lastName": null,
      "country": null,
      "address3": null,
      "address2": null,
      "city": null,
      "address1": null,
      "prefix": null,
      "companyName": null,
      "postalCode": null,
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "firstName": null,
      "phoneNumber": null,
      "alias": null,
      "faxNumber": null,
      "middleName": null,
      "state": null,
      "email": null
    },
    "items": [{
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 1432,
      "returnedQuantity": 0,
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "commerceItemId": "ci3000411",
      "assetId": "asset10001",
      "price": 1432,
      "variant": [
        {
          "optionValue": "Blue",
          "optionName": "Color"
        },
        {
          "optionValue": "Medium",
          "optionName": "Size"
        }
      ],
      "onSale": false,
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized within the shipping group",
      "unitPrice": 179,
      "serviceAccountId": "serviceAcc-123",
      "quantity": 8,
      "productId": "xprod2148",
      "salePrice": 0,
      "detailedItemPriceInfo": [{
        "discounted": false,
        "amount": 1432,
        "quantity": 8,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 179,
        "currencyCode": "USD"
      }],
      "externalRecurringCharge": 10,
      "externalRecurringChargeFrequency": "Monthly",
      "externalRecurringChargeDuration": "12",
      "catRefId": "xsku2148",
      "skuProperties": [{
        "propertyType": "sku-base",
        "name": "UPC Code",
        "id": "upcCode",
        "value": "123456"
      }],
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "activationDate": "2017-06-27T15:30:00Z",
      "listPrice": 179,
      "recurringCharge": 10,
      "status": "INITIAL"
    }]
  }],
  "recurringChargePriceInfo": {
    "amount": 30,
    "total": 32.4,
    "shipping": 0,
    "subTotalByFrequency": [{
      "amount": 30,
      "frequency": "Monthly"
    }],
    "taxByFrequency": [{
      "amount": 2.4,
      "frequency": "Monthly"
    }],
    "tax": 2.4,
    "subTotal": 30,
    "currencyCode": "USD",
    "totalWithoutTax": 30
  },
  "discountInfo": {
    "unclaimedCouponMultiPromotions": {"coupon2": [{
      "promotionLevel": "order",
      "promotionDesc": "promo4",
      "promotionId": "promo20004"
    }]},
    "orderCouponsMap": {
      "coupon1": {
        "promotionLevel": "order",
        "totalAdjustment": -1,
        "promotionDesc": "promo1",
        "promotionId": "promo20001"
      },
      "coupon2": {
        "promotionLevel": "order",
        "totalAdjustment": -1,
        "promotionDesc": "promo2",
        "promotionId": "promo20002"
      }
    },
    "orderDiscount": 0,
    "shippingDiscount": 0,
    "orderImplicitDiscountList": [{
      "promotionLevel": "item",
      "totalAdjustment": "-0.66",
      "promotionDesc": "Implicit Item Discount - 3PercentOff",
      "promotionId": "implicitItemPercentDiscount"
    }],
    "claimedCouponMultiPromotions": {
      "coupon1": [
        {
          "promotionLevel": "order",
          "totalAdjustment": -1,
          "promotionDesc": "promo1",
          "promotionId": "promo20001"
        },
        {
          "promotionLevel": "order",
          "totalAdjustment": -1,
          "promotionDesc": "promo3",
          "promotionId": "promo20003"
        }
      ],
      "coupon2": [{
        "promotionLevel": "order",
        "totalAdjustment": -1,
        "promotionDesc": "promo2",
        "promotionId": "promo20002"
      }]
    },
    "unclaimedCouponsMap": {"coupon2": {
      "promotionLevel": "order",
      "promotionDesc": "promo4",
      "promotionId": "promo20004"
    }}
  },
  "orderId": "o10002",
  "dynamicProperties": [{
    "id": "dynamicPropertyShippingInstructions",
    "label": "Shipping Instructions",
    "value": "Test Instructions"
  }],
  "shippingMethod": {
    "cost": 0,
    "value": "hardgoodShippingGroup"
  },
  "shoppingCart": {
    "numberOfItems": 8,
    "items": [{
      "deactivationDate": "2018-06-27T12:59:59Z",
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "commerceItemId": "ci3000411",
      "assetId": "asset10001",
      "price": 1432,
      "variant": [
        {
          "optionValue": "Blue",
          "optionName": "Color"
        },
        {
          "optionValue": "Medium",
          "optionName": "Size"
        }
      ],
      "onSale": false,
      "actionCode": "Add",
      "serviceId": "service-123",
      "unitPrice": 179,
      "serviceAccountId": "serviceAcc-123",
      "quantity": 8,
      "productId": "xprod2148",
      "externalRecurringCharge": 10,
      "giftWithPurchaseCommerceItemMarkers": [],
      "externalRecurringChargeFrequency": "Monthly",
      "catRefId": "xsku2148",
      "externalRecurringChargeDuration": "12",
      "skuProperties": [{
        "propertyType": "sku-base",
        "name": "UPC Code",
        "id": "upcCode",
        "value": "123456"
      }],
      "customerAccountId": "customerAcc-123",
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "activationDate": "2017-06-27T15:30:00Z",
      "recurringCharge": 10
    }]
  },
  "priceListGroup": {"repositoryId": "UsDollar"},
  "quoteInfo": {
    "providerNote": null,
    "notes": [{
      "profileType": null,
      "profileId": "120213",
      "requestDate": 1477479521002,
      "requesterNote": "This is a sample quote"
    }],
    "rejectionDate": null,
    "requestDate": "2016-10-26T10:58:41.002Z",
    "errorInfo": null,
    "externalID": null,
    "rejectionNote": null,
    "quoteDate": null,
    "expirationDate": null
  },
  "giftWithPurchaseOrderMarkers": [{
    "quantity": 1,
    "selectedQuantity": 0,
    "removedQuantity": 0,
    "data": "-1275480226",
    "automaticQuantity": 0,
    "giftType": "product",
    "autoRemove": true,
    "giftDetail": "camera_1",
    "repositoryId": "200001",
    "failedQuantity": 0,
    "value": "promo10002",
    "targetedQuantity": 0,
    "key": "atg.gwp"
  }]
}