updateOrder

put

/ccstore/v1/orders/{id}

Update Order. Update an order. 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. Dynamic Properties of order and order line items can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue").

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : updateOrder_request
Type: object
Show Source
Example:
{
    "priceGroupId":"defaultPriceGroup",
    "lastModifiedTime":1.409947606E12,
    "creationTime":1.409947604E12,
    "sourceSystem":"Cloud Commerce",
    "locale":"en",
    "salesChannel":"default",
    "paymentGroups":[
        {
            "PONumber":"9874",
            "expirationYear":"2016",
            "amountAuthorized":96.27,
            "amount":96.27,
            "expirationMonth":"05",
            "submittedDate":"2014-09-04T11:46:01.000Z",
            "authorizationStatus":[
                {
                    "transactionUuid":"fbd1adb5b1cc40209e8d39324d7f7f6d",
                    "authorizationDecision":"ACCEPT",
                    "amount":96.27,
                    "transactionSuccess":true,
                    "errorMessage":"Request was processed successfully.",
                    "currency":"USD",
                    "reasonCode":"100",
                    "transactionId":"4098167595050176195662"
                }
            ],
            "token":"9997000128471543",
            "paymentGroupClassType":"tokenizedCreditCard",
            "creditCardNumber":"1111",
            "paymentMethod":"tokenizedCreditCard",
            "billingAddress":{
                "lastName":"FLORES",
                "country":"US",
                "address3":null,
                "city":"Branford",
                "address2":null,
                "prefix":null,
                "address1":"Address Line 1",
                "companyName":null,
                "jobTitle":null,
                "postalCode":"32008",
                "county":null,
                "suffix":null,
                "ownerId":null,
                "firstName":"FLORENCE",
                "phoneNumber":"12345678",
                "faxNumber":null,
                "middleName":null,
                "state":"FL",
                "id":"pg10076",
                "email":"FLORENCE.FLORES@test.com"
            },
            "id":"pg10076",
            "currencyCode":"USD"
        }
    ],
    "organizationId":"100001",
    "relationships":[
        {
            "paymentGroupId":"pg10076",
            "amount":96.27,
            "relationshipType":"ORDERAMOUNTREMAINING",
            "id":"r10068"
        }
    ],
    "priceInfo":{
        "discounted":false,
        "secondaryCurrencyTaxAmount":1.5,
        "amount":89.97,
        "secondaryCurrencyShippingAmount":6,
        "secondaryCurrencyTotal":7.5,
        "manualAdjustmentTotal":0,
        "discountAmount":0,
        "tax":6.3,
        "rawSubtotal":89.97,
        "total":96.27,
        "shipping":0,
        "primaryCurrencyTotal":89.97,
        "amountIsFinal":false,
        "currencyCode":"USD"
    },
    "totalCommerceItemCount":3,
    "state":"SUBMITTED",
    "id":"o10076",
    "cancelReason":"badProductReview",
    "commerceItems":[
        {
            "deactivationDate":"2018-06-27T12:59:59Z",
            "returnedQuantity":0,
            "availabilityDate":null,
            "externalData":[
            ],
            "billingProfileId":"billingProfile-123",
            "billingAccountId":"billingAcc-123",
            "preOrderQuantity":1,
            "configuratorId":"123455",
            "assetKey":null,
            "priceInfo":{
                "discounted":false,
                "amount":89.97,
                "rawTotalPrice":89.97,
                "salePrice":0,
                "priceListId":"listPrices",
                "quantityDiscounted":0,
                "amountIsFinal":false,
                "onSale":false,
                "shippingSurcharge":10,
                "discountable":true,
                "currencyCode":"USD",
                "currentPriceDetailsSorted":[
                    {
                        "discounted":false,
                        "amount":89.97,
                        "quantity":3,
                        "amountIsFinal":false,
                        "range":{
                            "lowBound":0,
                            "highBound":2,
                            "size":3
                        },
                        "tax":6.3,
                        "detailedUnitPrice":29.99,
                        "currencyCode":"USD"
                    }
                ],
                "listPrice":29.99
            },
            "catalogId":null,
            "assetId":"asset10001",
            "externalRecurringChargeDetails":{
                "externalRecurringCharge":10,
                "externalRecurringChargeFrequency":"Monthly",
                "externalRecurringChargeDuration":"12"
            },
            "externalPriceDetails":{
                "externalPriceQuantity":1,
                "externalPrice":100
            },
            "actionCode":"Add",
            "id":"ci1000076",
            "serviceId":"service-123",
            "locationInventoryInfoMap":{
                "__NULL__":{
                    "availabilityDate":null,
                    "preOrderQuantity":0,
                    "backOrderQuantity":1,
                    "inStockQuantity":0
                },
                "Boston128":{
                    "availabilityDate":null,
                    "preOrderQuantity":1,
                    "backOrderQuantity":0,
                    "inStockQuantity":1
                }
            },
            "commerceItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "addOnItem":false,
                    "quantity":1,
                    "productId":"prod40001",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":null,
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catalogRefId":"sku40001",
                    "assetKey":null,
                    "customerAccountId":"customerAcc-123",
                    "recurringChargePriceInfo":{
                        "discounted":false,
                        "amount":10,
                        "rawTotalPrice":10,
                        "salePrice":0,
                        "priceListId":null,
                        "quantityDiscounted":0,
                        "amountIsFinal":false,
                        "onSale":false,
                        "shippingSurcharge":0,
                        "discountable":true,
                        "currentPriceDetailsSorted":[
                            {
                                "discounted":false,
                                "amount":10,
                                "quantity":1,
                                "amountIsFinal":false,
                                "range":{
                                    "lowBound":0,
                                    "highBound":0,
                                    "size":1
                                },
                                "tax":0,
                                "orderDiscountShare":0,
                                "detailedUnitPrice":10,
                                "currencyCode":"USD"
                            }
                        ],
                        "currencyCode":"USD",
                        "listPrice":0
                    },
                    "assetId":"asset10001",
                    "externalRecurringChargeDetails":{
                        "externalRecurringCharge":10,
                        "externalRecurringChargeFrequency":"Monthly",
                        "externalRecurringChargeDuration":"12"
                    },
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                },
                {
                    "serviceAccountId":"serviceAcc-123",
                    "configurationOptionId":"sku2442",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "addOnItem":true,
                    "quantity":1,
                    "productId":"prod40002",
                    "externalData":[
                    ],
                    "parentAssetKey":null,
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":null,
                    "configurablePropertyId":"product10222",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catalogRefId":"sku40005",
                    "assetKey":null,
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "actionCode":"Add",
                    "shopperInput":{
                        "message":"Best Wishes my friend",
                        "font":"courier"
                    },
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ],
            "serviceAccountId":"serviceAcc-123",
            "quantity":3,
            "productId":"prod10021",
            "externalId":null,
            "parentAssetKey":null,
            "originalCommerceItemId":null,
            "rootAssetKey":null,
            "transactionDate":"2018-06-27T12:59:59Z",
            "catalogRefId":"sku10017",
            "customerAccountId":"customerAcc-123",
            "recurringChargePriceInfo":{
                "discounted":false,
                "amount":10,
                "rawTotalPrice":10,
                "salePrice":0,
                "priceListId":null,
                "quantityDiscounted":0,
                "amountIsFinal":false,
                "onSale":false,
                "shippingSurcharge":0,
                "discountable":true,
                "currentPriceDetailsSorted":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "amountIsFinal":false,
                        "range":{
                            "lowBound":0,
                            "highBound":0,
                            "size":1
                        },
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "currencyCode":"USD",
                "listPrice":0
            },
            "catalogKey":null,
            "productDisplayName":"Wii Classic Controller",
            "shopperInput":{
                "color":"neon",
                "initials":"M.C.K",
                "font":"courier"
            },
            "activationDate":"2017-06-27T15:30:00Z",
            "asset":false,
            "backOrderQuantity":1
        }
    ],
    "taxPriceInfo":{
        "discounted":false,
        "cityTax":0,
        "secondaryCurrencyTaxAmount":1.5,
        "amount":6.3,
        "countyTax":0.9,
        "amountIsFinal":false,
        "districtTax":0,
        "stateTax":5.4,
        "currencyCode":"USD",
        "countryTax":0
    },
    "shippingGroups":[
        {
            "lastName":"Black",
            "shippingMethod":"freeShippingMethod",
            "description":"sg10076",
            "submittedDate":null,
            "priceInfo":{
                "discounted":false,
                "secondaryCurrencyTaxAmount":1.5,
                "amount":0,
                "secondaryCurrencyShippingAmount":6,
                "rawShipping":0,
                "amountIsFinal":false,
                "currencyCode":"USD"
            },
            "firstName":"Joe",
            "phoneNumber":"123456789",
            "shipOnDate":null,
            "actualShipDate":null,
            "trackingInfo":[
                {
                    "carrierName":"USPS",
                    "trackingUrl":"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=ABC123",
                    "carrierId":"USPS",
                    "trackingNumber":"ABC123"
                }
            ],
            "specialInstructions":{
            },
            "shippingAddress":{
                "lastName":"FLORES",
                "country":"US",
                "address3":null,
                "city":"Branford",
                "address2":null,
                "prefix":null,
                "address1":"203 Main Street",
                "companyName":null,
                "jobTitle":null,
                "postalCode":"32008",
                "county":null,
                "suffix":null,
                "ownerId":null,
                "firstName":"FLORENCE",
                "phoneNumber":"9087654321",
                "faxNumber":null,
                "middleName":null,
                "state":"FL",
                "id":"sg10076",
                "email":"FLORENCE.FLORES@test.com"
            },
            "commerceItemRelationships":[
                {
                    "availablePickupDate":"2018-07-23T12:12:58.000Z",
                    "commerceItemId":"ci1000076",
                    "inventoryLocationId":null,
                    "amount":0,
                    "quantity":3,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "pointOfNoRevision":true,
                    "returnedQuantity":0,
                    "preferredPickupDate":"2018-07-23T12:12:58.000Z",
                    "commerceItemExternalId":null,
                    "id":"r10066"
                }
            ],
            "state":"INITIAL",
            "id":"sg10076",
            "stateDetail":null,
            "trackingNumber":"USPS-ABC123",
            "email":"a.a@a.com",
            "handlingInstructions":[
            ],
            "shippingGroupClassType":"hardgoodShippingGroup"
        }
    ],
    "taxExempt":false,
    "profile":{
        "lastName":"FLORES",
        "firstName":"FLORENCE",
        "shippingAddress":{
            "country":"US",
            "phoneNumber":null,
            "address3":null,
            "address2":null,
            "city":"Branford",
            "address1":"203 Main Street",
            "postalCode":"32008",
            "county":null,
            "state":null
        },
        "middleName":null,
        "email":"FLORENCE.FLORES@test.com"
    },
    "shippingGroupCount":1,
    "orderAction":"order",
    "paymentGroupCount":1,
    "recurringChargePriceInfo":{
        "discounted":false,
        "amount":30,
        "total":32.4,
        "shipping":0,
        "subTotalByFrequency":[
            {
                "amount":30,
                "frequency":"Monthly"
            }
        ],
        "taxByFrequency":[
            {
                "amount":2.4,
                "frequency":"Monthly"
            }
        ],
        "manualAdjustmentTotal":0,
        "amountIsFinal":false,
        "discountAmount":0,
        "tax":2.4,
        "rawSubtotal":30,
        "currencyCode":"USD"
    },
    "profileId":"se-570031",
    "siteId":"siteUS"
}
Nested Schema : commerceItems
Type: array
The commerce items (sometimes referred to as "line items") represent which actual skus are included in the order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
Show Source
Nested Schema : paymentGroups
Type: array
The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
Show Source
Nested Schema : priceInfo
Type: object
Pricing information, an instance of OrderPriceInfo.
Show Source
Nested Schema : profile
Type: object
Basic profile information. (read-only)
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information of the order
Show Source
Nested Schema : updateOrderRequestShippingGroups
Type: array
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : items
Type: object
Show Source