REST API for Oracle Commerce Cloud December 2017

createOrder

post

/ccagent/v1/orders

Create Order. It can createOrder/priceOrder/preAuthorizeOrder/submitOrder/resendOrdersForFulfillment order for a customer based on operations. Operations can be any of createOrder, priceOrder, preAuthorizeOrder, submitOrder. Dynamic Properties of order can be added in the the request using the key value pair structure ("dynamicPropertyKey":"dynamicPropertyValue"). These property values can take the types of boolean, date, float, string, timestamp, enumerated, big string. Storefront also has an endopint with same id ('createOrder'), but the behaviour is different. For more informaiton refer Storefront API. This takes additonal header paramater x-ccsite to create the order in specific site. If the header information is not provided order is created on default site. 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 on which the orders needs to be placed

Body Parameter

Root Schema : createOrder_request

Example


{
    "isAnonymousCheckout":true,
    "appliedPromotions":[
        "explicitItemFreeDiscount"
    ],
    "shippingMethod":{
        "value":"ground"
    },
    "payments":[
        {
            "paymentGroupId":"",
            "amount":100,
            "customProperties":{
                "EMIS":"12",
                "MontlyCharge":"$100"
            },
            "giftCardNumber":"6035710988880101071",
            "giftCardPin":"123",
            "type":"physicalGiftCard"
        },
        {
            "PONumber":"123456",
            "type":"invoice"
        },
        {
            "cardCVV":"123",
            "customProperties":{
                "EMIS":"12",
                "MontlyCharge":"$100"
            },
            "nameOnCard":"test",
            "cardTypeName":"Visa",
            "cardType":"visa",
            "endMonth":"02",
            "type":"card",
            "endYear":2018,
            "cardNumber":"4055011111111111"
        }
    ],
    "shoppingCart":{
        "coupons":[
            {
                "code":"FREETATTOO",
                "level":"item",
                "description":"Explicit Item Discount - FREETATTOO",
                "id":"explicitItemFreeDiscount",
                "totalAdjustment":"-21.99",
                "status":"claimed"
            }
        ],
        "items":[
            {
                "serviceAccountId":"serviceAcc-123",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "quantity":1,
                "dynamicPropertyMode":"pickup",
                "productId":"xprod2105",
                "externalRecurringCharge":10,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "externalPriceQuantity":1,
                "externalRecurringChargeFrequency":"Monthly",
                "catRefId":"xsku2105",
                "externalRecurringChargeDuration":"12",
                "externalPrice":255.1,
                "customerAccountId":"customerAcc-123",
                "assetId":"asset10001",
                "actionCode":"Add",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "serviceId":"service-123",
                "recurringCharge":10
            }
        ],
        "orderTotal":255.1
    },
    "shippingAddress":{
        "lastName":"Test",
        "country":"United States",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "prefix":"",
        "address1":"Line 1",
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "email":"steve.test@oracle.com",
        "selectedState":"AL",
        "state_ISOCode":"US-AL"
    },
    "billingAddress":{
        "lastName":"Test",
        "country":"United States",
        "address3":"",
        "address2":"Line 2",
        "city":"Montgomery",
        "prefix":"",
        "address1":"Line 1",
        "postalCode":"36123",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Steve",
        "phoneNumber":"45454545",
        "faxNumber":"",
        "alias":"",
        "middleName":"",
        "state":"Alabama",
        "selectedState":"AL",
        "state_ISOCode":"US-AL"
    },
    "dynamicPropertyShippingInstructions":"Test Instructions"
}

Request

Response

Example application/json

Examples