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

approveOrder

post

/ccagent/v1/orders/approve

Approve Order. Approver approves an order. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.

Request

Supported Media Types
  • application/json
Header Parameters
X-CCOrganization
Type: string
the organization Id in which order should be created
X-CCSite
Type: string
the site Id in which order should be created
Body Parameter
Root Schema : approveOrder_request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : approveOrder_response
Nested Schema : approvers
Type: array
List of approvers of the organization.
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
Gift Selection Information
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
Gift With Purchase order markers 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 : priceInfo
Type: object
The price information.
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
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.
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 : items
Type: object
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 : couponCode
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 : couponCode
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 : currency
Type: object
Currency of the PriceList group.
Nested Schema : GiftWithPurchaseMessages
Type: array
The GWP messages information.
Nested Schema : items
Type: object
Nested Schema : params
Type: array
The list of all message parameters.
Nested Schema : items
Type: object
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 : items
Type: array
Items in the cart.
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 : skuProperties
Type: array
Sku properties Information
Nested Schema : variant
Type: array
Product Variant Information.
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
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 : skuProperties
Type: array
Sku properties Information
Nested Schema : variant
Type: array
Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
Child items of the commerce item
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Nested Schema : items
Type: object
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
Nested Schema : items
Type: object
Example application/json

{
    "gwp":false,
    "lastModifiedTime":1.488091242E12,
    "priceGroupId":"defaultPriceGroup",
    "creationTime":1.488090529E12,
    "gwpMarkers":[
    ],
    "salesChannel":"contactCenter",
    "submittedDate":null,
    "locale":"en",
    "paymentGroups":[
        {
            "expirationYear":null,
            "amountAuthorized":0,
            "amount":309.92,
            "gatewayName":null,
            "expirationMonth":null,
            "submittedDate":null,
            "authorizationStatus":[
            ],
            "token":null,
            "paymentGroupClassType":"tokenizedCreditCard",
            "creditCardNumber":null,
            "paymentMethod":"tokenizedCreditCard",
            "state":"INITIAL",
            "id":"pg40411",
            "billingAddress":{
                "lastName":null,
                "country":null,
                "address3":null,
                "address2":null,
                "city":null,
                "prefix":null,
                "address1":null,
                "postalCode":null,
                "companyName":null,
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "ownerId":null,
                "selectedCountry":null,
                "firstName":null,
                "phoneNumber":null,
                "faxNumber":null,
                "middleName":null,
                "state":null,
                "email":null,
                "selectedState":null,
                "state_ISOCode":null
            },
            "debitStatus":[
            ],
            "currencyCode":"USD"
        }
    ],
    "configuratorId":null,
    "organizationId":"or-100002",
    "relationships":[
        {
            "paymentGroupId":"pg40411",
            "amount":309.92,
            "relationshipType":"ORDERAMOUNTREMAINING",
            "id":"r50389"
        }
    ],
    "priceInfo":{
        "discounted":false,
        "amount":249.99,
        "total":309.92,
        "shipping":35,
        "manualAdjustmentTotal":0,
        "amountIsFinal":false,
        "discountAmount":0,
        "tax":24.93,
        "rawSubtotal":249.99,
        "currencyCode":"USD"
    },
    "totalCommerceItemCount":1,
    "id":"o40411",
    "state":"PENDING_PAYMENT",
    "quoteInfo":null,
    "taxCalculated":true,
    "commerceItems":[
        {
            "priceInfo":{
                "discounted":true,
                "amount":249.99,
                "rawTotalPrice":299.99,
                "salePrice":0,
                "priceListId":"listPrices",
                "quantityDiscounted":1,
                "amountIsFinal":false,
                "onSale":false,
                "shippingSurcharge":0,
                "discountable":true,
                "currentPriceDetailsSorted":[
                    {
                        "discounted":true,
                        "amount":249.99,
                        "quantity":1,
                        "amountIsFinal":false,
                        "range":{
                            "lowBound":0,
                            "highBound":0,
                            "size":1
                        },
                        "tax":21.86,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":249.99,
                        "currencyCode":"USD"
                    }
                ],
                "currencyCode":"USD",
                "listPrice":299.99
            },
            "quantity":1,
            "catalogId":null,
            "productId":"prod10015",
            "returnedQuantity":0,
            "lineAttributes":[
            ],
            "catalogKey":null,
            "productDisplayName":"Playstation 3",
            "externalPriceDetails":null,
            "externalId":null,
            "id":"ci4000413",
            "catalogRefId":"sku10032"
        }
    ],
    "taxPriceInfo":{
        "discounted":false,
        "valueAddedTax":0,
        "amount":24.93,
        "countyTax":0.71,
        "isTaxIncluded":false,
        "miscTax":6.41,
        "districtTax":0,
        "stateTax":17.1,
        "miscTaxInfo":{
            "Special":6.41
        },
        "countryTax":0,
        "cityTax":0.71,
        "amountIsFinal":false,
        "currencyCode":"USD"
    },
    "freezeDate":"2017-02-26T06:40:42.000Z",
    "shippingGroups":[
        {
            "shippingMethod":"standardShippingMethod",
            "description":"sg50411",
            "submittedDate":null,
            "priceInfo":{
                "discounted":false,
                "shippingTax":3.07,
                "amount":35,
                "rawShipping":35,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "shipOnDate":null,
            "actualShipDate":null,
            "specialInstructions":{
            },
            "shippingAddress":{
                "lastName":"Blooming",
                "country":"US",
                "address3":null,
                "address2":"Santa Clara County",
                "city":"San Jose",
                "prefix":null,
                "address1":"7 W Jackson Blvd",
                "postalCode":"95111",
                "companyName":"US Motor Works, Inc.",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "ownerId":null,
                "selectedCountry":"US",
                "firstName":"Ron",
                "phoneNumber":"408-752-3500",
                "faxNumber":null,
                "middleName":null,
                "state":"CA",
                "email":"ron@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            "commerceItemRelationships":[
                {
                    "commerceItemId":"ci4000413",
                    "amount":0,
                    "quantity":1,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "returnedQuantity":0,
                    "range":{
                        "lowBound":0,
                        "highBound":0,
                        "size":1
                    },
                    "commerceItemExternalId":null,
                    "state":"INITIAL",
                    "id":"r50387"
                }
            ],
            "state":"INITIAL",
            "id":"sg50411",
            "stateDetail":null,
            "trackingNumber":null,
            "handlingInstructions":[
            ],
            "shippingGroupClassType":"hardgoodShippingGroup"
        }
    ],
    "taxExempt":false,
    "lastModifiedDate":"2017-02-26T06:40:42.000Z",
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "profile":{
        "lastName":"Blooming",
        "firstName":"Ron",
        "shippingAddress":null,
        "middleName":null,
        "parentOrganization":{
            "name":"US Motor Works, Inc.",
            "id":"or-100002"
        },
        "email":"ron@example.com"
    },
    "shippingGroupCount":1,
    "paymentGroupCount":1,
    "profileId":"bb-110023",
    "siteId":"siteUS",
    "activeQuoteOrderId":null
}
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| |28390|The following item(s) are no longer for sale [ItemName]. Order cannot be approved.|
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:

{
  "approverMessage": "Approving order",
  "orderId": "o40411"
}

Sample Response Payload returned by endpoint:

{
  "gwp": false,
  "lastModifiedTime": 1488091242000,
  "priceGroupId": "defaultPriceGroup",
  "creationTime": 1488090529000,
  "gwpMarkers": [],
  "salesChannel": "contactCenter",
  "submittedDate": null,
  "locale": "en",
  "paymentGroups": [{
    "expirationYear": null,
    "amountAuthorized": 0,
    "amount": 309.92,
    "gatewayName": null,
    "expirationMonth": null,
    "submittedDate": null,
    "authorizationStatus": [],
    "token": null,
    "paymentGroupClassType": "tokenizedCreditCard",
    "creditCardNumber": null,
    "paymentMethod": "tokenizedCreditCard",
    "state": "INITIAL",
    "id": "pg40411",
    "billingAddress": {
      "lastName": null,
      "country": null,
      "address3": null,
      "address2": null,
      "city": null,
      "prefix": null,
      "address1": null,
      "postalCode": null,
      "companyName": null,
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "ownerId": null,
      "selectedCountry": null,
      "firstName": null,
      "phoneNumber": null,
      "faxNumber": null,
      "middleName": null,
      "state": null,
      "email": null,
      "selectedState": null,
      "state_ISOCode": null
    },
    "debitStatus": [],
    "currencyCode": "USD"
  }],
  "configuratorId": null,
  "organizationId": "or-100002",
  "relationships": [{
    "paymentGroupId": "pg40411",
    "amount": 309.92,
    "relationshipType": "ORDERAMOUNTREMAINING",
    "id": "r50389"
  }],
  "priceInfo": {
    "discounted": false,
    "amount": 249.99,
    "total": 309.92,
    "shipping": 35,
    "manualAdjustmentTotal": 0,
    "amountIsFinal": false,
    "discountAmount": 0,
    "tax": 24.93,
    "rawSubtotal": 249.99,
    "currencyCode": "USD"
  },
  "totalCommerceItemCount": 1,
  "id": "o40411",
  "state": "PENDING_PAYMENT",
  "quoteInfo": null,
  "taxCalculated": true,
  "commerceItems": [{
    "priceInfo": {
      "discounted": true,
      "amount": 249.99,
      "rawTotalPrice": 299.99,
      "salePrice": 0,
      "priceListId": "listPrices",
      "quantityDiscounted": 1,
      "amountIsFinal": false,
      "onSale": false,
      "shippingSurcharge": 0,
      "discountable": true,
      "currentPriceDetailsSorted": [{
        "discounted": true,
        "amount": 249.99,
        "quantity": 1,
        "amountIsFinal": false,
        "range": {
          "lowBound": 0,
          "highBound": 0,
          "size": 1
        },
        "tax": 21.86,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 249.99,
        "currencyCode": "USD"
      }],
      "currencyCode": "USD",
      "listPrice": 299.99
    },
    "quantity": 1,
    "catalogId": null,
    "productId": "prod10015",
    "returnedQuantity": 0,
    "lineAttributes": [],
    "catalogKey": null,
    "productDisplayName": "Playstation 3",
    "externalPriceDetails": null,
    "externalId": null,
    "id": "ci4000413",
    "catalogRefId": "sku10032"
  }],
  "taxPriceInfo": {
    "discounted": false,
    "valueAddedTax": 0,
    "amount": 24.93,
    "countyTax": 0.71,
    "isTaxIncluded": false,
    "miscTax": 6.41,
    "districtTax": 0,
    "stateTax": 17.1,
    "miscTaxInfo": {"Special": 6.41},
    "countryTax": 0,
    "cityTax": 0.71,
    "amountIsFinal": false,
    "currencyCode": "USD"
  },
  "freezeDate": "2017-02-26T06:40:42.000Z",
  "shippingGroups": [{
    "shippingMethod": "standardShippingMethod",
    "description": "sg50411",
    "submittedDate": null,
    "priceInfo": {
      "discounted": false,
      "shippingTax": 3.07,
      "amount": 35,
      "rawShipping": 35,
      "amountIsFinal": false,
      "currencyCode": "USD"
    },
    "shipOnDate": null,
    "actualShipDate": null,
    "specialInstructions": {},
    "shippingAddress": {
      "lastName": "Blooming",
      "country": "US",
      "address3": null,
      "address2": "Santa Clara County",
      "city": "San Jose",
      "prefix": null,
      "address1": "7 W Jackson Blvd",
      "postalCode": "95111",
      "companyName": "US Motor Works, Inc.",
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "ownerId": null,
      "selectedCountry": "US",
      "firstName": "Ron",
      "phoneNumber": "408-752-3500",
      "faxNumber": null,
      "middleName": null,
      "state": "CA",
      "email": "ron@example.com",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    "commerceItemRelationships": [{
      "commerceItemId": "ci4000413",
      "amount": 0,
      "quantity": 1,
      "relationshipType": "SHIPPINGQUANTITY",
      "returnedQuantity": 0,
      "range": {
        "lowBound": 0,
        "highBound": 0,
        "size": 1
      },
      "commerceItemExternalId": null,
      "state": "INITIAL",
      "id": "r50387"
    }],
    "state": "INITIAL",
    "id": "sg50411",
    "stateDetail": null,
    "trackingNumber": null,
    "handlingInstructions": [],
    "shippingGroupClassType": "hardgoodShippingGroup"
  }],
  "taxExempt": false,
  "lastModifiedDate": "2017-02-26T06:40:42.000Z",
  "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."],
  "profile": {
    "lastName": "Blooming",
    "firstName": "Ron",
    "shippingAddress": null,
    "middleName": null,
    "parentOrganization": {
      "name": "US Motor Works, Inc.",
      "id": "or-100002"
    },
    "email": "ron@example.com"
  },
  "shippingGroupCount": 1,
  "paymentGroupCount": 1,
  "profileId": "bb-110023",
  "siteId": "siteUS",
  "activeQuoteOrderId": null
}