REST API for Oracle Commerce Cloud December 2017 - updateCurrentProfileOrder

Previous Next JavaScript must be enabled to correctly display this content

updateCurrentProfileOrder

post

/ccstore/v1/orders/current

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

Request

Supported Media Types

application/json

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

Body Parameter

Root Schema : updateCurrentProfileOrder_request


{
    "op":"update",
    "payments":[
        {
            "amount":"100.0",
            "giftCardNumber":"6035710988880101071",
            "giftCardPin":"",
            "type":"physicalGiftCard"
        }
    ],
    "shoppingCart":{
        "coupons":[
            {
                "code":"coupon1",
                "level":"order",
                "description":"promo1",
                "id":"promo20001",
                "totalAdjustment":-1,
                "status":"claimed"
            },
            {
                "code":"coupon2",
                "level":"",
                "description":"",
                "id":"",
                "status":""
            }
        ],
        "numberOfItems":1,
        "items":[
            {
                "unitPrice":40,
                "serviceAccountId":"serviceAcc-123",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "quantity":1,
                "dynamicPropertyMode":"pickup",
                "productId":"xprod1047",
                "externalRecurringCharge":10,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "externalRecurringChargeFrequency":"Monthly",
                "catRefId":"xsku1242",
                "externalRecurringChargeDuration":"12",
                "customerAccountId":"customerAcc-123",
                "price":40,
                "assetId":"asset10001",
                "onSale":true,
                "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
            }
        ]
    },
    "id":"o10001",
    "dynamicPropertyShippingInstructions":"Test Instructions"
}

combineLineItems: Type: string

Value to determine if line items are to be combined. Can be yes or no.
id: Type: string

Updates the order corresponding to the passed orderId.
op: Type: string

Required: true

Set to update for updating the current order, or create for creating a new incomplete order.
payments: Type: array payments

Additional Properties Allowed:

The array of payments containing only gift card payments to be sent to reprice the order.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:

The shipping groups for the order.
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:

Shopping cart information.

Nested Schema : payments

Type: array

The array of payments containing only gift card payments to be sent to reprice the order.

Type: object items

Additional Properties Allowed:

Nested Schema : shippingGroups

Type: array

The shipping groups for the order.

Type: object items

Additional Properties Allowed:

Nested Schema : shoppingCart

Type: object

Shopping cart information.

coupons: Type: array coupons

Additional Properties Allowed:

The array of coupons applied to the order.
items: Type: array items

Additional Properties Allowed:

Items in the cart.
numberOfItems: Type: integer

Required: true

Number of items in the cart.

Nested Schema : items

Type: object

amount: Type: string

Required: true

The total balance on the gift card.
giftCardNumber: Type: string

Required: true

Gift card number. Payment type:physicalGiftCard.
giftCardPin: Type: string

Gift card pin. Payment type:physicalGiftCard.
type: Type: string

Required: true

The type of the payment. e.g. physicalGiftCard.

Nested Schema : items

Type: object

items: Type: array items

Required: true

Additional Properties Allowed:

The array of products in the shipping group.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingMethod: Type: object shippingMethod

Required: true

Additional Properties Allowed:

The shipping method details for the order.

Nested Schema : items

Type: array

The array of products in the shipping group.

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

The shipping address details.

address1: Type: string

Required: true

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

Required: true

City.
companyName: Type: string

Company name.
country: Type: string

Required: true

Country.
county: Type: string

County.
email: Type: string

Required: true

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

Required: true

First name.
jobTitle: Type: string

Job title.
lastName: Type: string

Required: true

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Required: true

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Required: true

Country code.
selectedState: Type: string

Required: true

State code.
state: Type: string

Required: true

State.
state_ISOCode: Type: string

Required: true

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

value: Type: string

Required: true

The shipping method applied to the order.

Nested Schema : items

Type: object

catRefId: Type: string

Required: true

The category to which the product belongs.
commerceItemId: Type: string

The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
productId: Type: string

Required: true

ID of the product in the cart.
quantity: Type: integer

Required: true

The quantity of the product in this shipping group.
recurringCharge: Type: number

The recurring charge for the item.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : coupons

Type: array

The array of coupons applied to the order.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: array

Items in the cart.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

code: Type: string

The coupon code.
description: Type: string

The promotion description.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
id: Type: string

The promotion id.
level: Type: string

The level of the promotion (whether the coupon is item level, etc).
recurringCharge: Type: number

The recurring charge for the item.
status: Type: string

The current status of the coupon.
totalAdjustment: Type: string

Adjustment done by the promotion.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

Required: true

Sku reference id.
childItems: Type: array childItems

Additional Properties Allowed:

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.
commerceItemId: Type: string

The unique line item ID distinguisher.This field becomes required for split shipping when combineLineItems is set to no.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
giftWithPurchaseCommerceItemMarkers: Type: array giftWithPurchaseCommerceItemMarkers

Additional Properties Allowed:

giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.
giftWithPurchaseSelections: Type: array giftWithPurchaseSelections

Additional Properties Allowed:

The array of gift with purchase selections to be made.
price: Type: number

Required: true

Price of the items.
productId: Type: string

Required: true

ID of the product in the cart.
quantity: Type: integer

Required: true

Quantity of the items.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.

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.

Type: object items

Additional Properties Allowed:

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseCommerceItemMarkers

Type: array

giftWithPurchaseCommerceItemMarker information. If giftWithPurchaseCommerceItemMarker information is present on the order is should be passed in.

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseSelections

Type: array

The array of gift with purchase selections to be made.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

Required: true

Sku reference id.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

Required: true

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

Required: true

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). The value of this property should be -1 in case if the current item is a sub item of a configurable product
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
productId: Type: string

Required: true

ID of the product in the cart.
quantity: Type: integer

Required: true

The quantity of the product in the cart.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

Required: true

The name to be associated with the externalData item.
values: Type: object values

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

automaticQuantity: Type: number

Required: true

The quantity of the free gift that this commerce item is making free and was auto added by pricing.
data: Type: integer

Required: true

The gift hash code for this gift with purchase promotion.
key: Type: string

Required: true

atg.gwp
remainingQuantity: Type: number

Required: true

The quantity of the commerce item that is not affected by gift with purchase.
selectedQuantity: Type: number

Required: true

The quantity of the free gift that this commerce item is making free and was selected by the shopper.
targetedQuantity: Type: number

Required: true

The quantity of the free gift that this commerce item is making free and was targeted by pricing.
value: Type: string

Required: true

The gift with purchase promotion id.

Nested Schema : items

Type: object

catRefId: Type: string

The product variant Id. Include this Id when you are wishing to mark this as a gift with purchase selection you wish to change out
giftWithPurchaseIdentifier: Type: integer

Required: true

The identifier that links this gift with purchase to the giftWithPurchaseInfo.
giftWithPurchaseQuantity: Type: integer

Required: true

The total quantity of the commerceItem that is giftWithPurchaseQuantity.
productId: Type: string

ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out
promotionId: Type: string

Required: true

The promotion id.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateCurrentProfileOrder_response

discountInfo: Type: object discountInfo

Additional Properties Allowed:

Discount Information
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

Read-only list of dynamic properties for the order along with meta-data.
giftWithPurchaseOrderMarkers: Type: array giftWithPurchaseOrderMarkers

Additional Properties Allowed:

gift with purchase order marker information
orderId: Type: string

Order ID of the order to remove.
payments: Type: array payments

Additional Properties Allowed:

Payment details for the pricing call, including additional properties specific to the payment type.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

Price information of the order.
pricingMessages: Type: object pricingMessages

Additional Properties Allowed:

The Pricing messages information.
quoteInfo: Type: object quoteInfo

Additional Properties Allowed:

the quote information of the order
recurringChargePriceInfo: Type: object recurringChargePriceInfo

Additional Properties Allowed:

Recurring charge price information.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:

The shipping groups for the order.
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:

Shopping cart information.
siteId: Type: string

The id of the site in which the order was created

Nested Schema : discountInfo

Type: object

Discount Information

claimedCouponMultiPromotions: Type: object claimedCouponMultiPromotions

Additional Properties Allowed:

The coupons that were claimed
orderCouponsMap: Type: object orderCouponsMap

Additional Properties Allowed:

The coupons that were claimed
orderDiscount: Type: number

Order Discount
orderImplicitDiscountList: Type: array orderImplicitDiscountList

Additional Properties Allowed:

Implicit Promotions for the order
shippingDiscount: Type: number

Shipping Discount
unclaimedCouponMultiPromotions: Type: object unclaimedCouponMultiPromotions

Additional Properties Allowed:

The coupons that were not claimed
unclaimedCouponsMap: Type: object unclaimedCouponsMap

Additional Properties Allowed:

The coupons that were not claimed

Nested Schema : dynamicProperties

Type: array

Read-only list of dynamic properties for the order along with meta-data.

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseOrderMarkers

Type: array

gift with purchase order marker information

Type: object items

Additional Properties Allowed:

Nested Schema : payments

Type: array

Payment details for the pricing call, including additional properties specific to the payment type.

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

Price information of the order.

amount: Type: number

Amount of order.
currencyCode: Type: string

Currency code.
shipping: Type: number

Shipping price of order.
shippingSurchargeValue: Type: number

Extra handling costs for shipping the products.
subTotal: Type: number

Sub total.
tax: Type: number

Tax.
total: Type: number

Total amount of order.

Nested Schema : pricingMessages

Type: object

The Pricing messages information.

giftWithPurchaseMessages: Type: array giftWithPurchaseMessages

Additional Properties Allowed:

The gift with purchase messages information.

Nested Schema : quoteInfo

Type: object

the quote information of the order

errorInfo: Type: array errorInfo

Additional Properties Allowed:

the array of errors, if any
expirationDate: Type: string

the expiration date of the quoted order, if any
externalId: Type: string

the external id for the quote
notes: Type: array notes

Additional Properties Allowed:

the notes (history) for the order
providerNote: Type: string

the provider note for the quoted order
quoteDate: Type: number

the date the order was quoted in milliseconds
rejectionDate: Type: string

rejection date of the quoted order
rejectionNote: Type: string

the rejection note for an order whose quote has been rejected by user
requestDate: Type: string

the date when the quote was requested in ISO format

Nested Schema : recurringChargePriceInfo

Type: object

Recurring charge price information.

amount: Type: number

The monetary amount of this recurring charge.
currencyCode: Type: string

The currency code for the monetary amounts. A three character currency code such as USD.
frequencyAmountTotals: Type: array frequencyAmountTotals

Additional Properties Allowed:

The total for each recurring charge frequency
frequencyTaxTotals: Type: array frequencyTaxTotals

Additional Properties Allowed:

The tax for each recurring charge frequency
shipping: Type: number

Cost of shipping the product.
subTotal: Type: number

The sub-total price of the recurring charge.
tax: Type: number

Monetary tax amount.
total: Type: number

The total price of the recurring charge.
totalWithoutTax: Type: number

Total of recurring amount without tax included.

Nested Schema : shippingGroups

Type: array

The shipping groups for the order.

Type: object items

Additional Properties Allowed:

Nested Schema : shoppingCart

Type: object

Shopping cart information.

items: Type: array items

Additional Properties Allowed:

Items in the cart.
numberOfItems: Type: integer

Number of items in the cart.

Nested Schema : claimedCouponMultiPromotions

Type: object

The coupons that were claimed

coupon code: Type: array coupon code

Additional Properties Allowed:

Coupon Code, corresponding to which promotions were applied

Nested Schema : orderCouponsMap

Type: object

The coupons that were claimed

coupon code: Type: object coupon code

Additional Properties Allowed:

Coupon Code

Nested Schema : orderImplicitDiscountList

Type: array

Implicit Promotions for the order

Type: object items

Additional Properties Allowed:

Nested Schema : unclaimedCouponMultiPromotions

Type: object

The coupons that were not claimed

coupon code: Type: array coupon code

Additional Properties Allowed:

Coupon Code, corresponding to which some promotions were not applied

Nested Schema : unclaimedCouponsMap

Type: object

The coupons that were not claimed

coupon code: Type: object coupon code

Additional Properties Allowed:

Coupon Code

Nested Schema : coupon code

Type: array

Coupon Code, corresponding to which promotions were applied

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.
totalAdjustment: Type: number

Adjustment done by the promotion

Nested Schema : coupon code

Type: object

Coupon Code

promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.
totalAdjustment: Type: number

Adjustment done by the promotion

Nested Schema : items

Type: object

promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : coupon code

Type: array

Coupon Code, corresponding to which some promotions were not applied

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : coupon code

Type: object

Coupon Code

promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

Promotion Id
promotionLevel: Type: string

Promotion Level
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : items

Type: object

id: Type: string

The ID of the dynamic property.
label: Type: string

The label of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

automaticQuantity: Type: number

The quantity of free sku for this gift selection that has already been auto added to the order.
autoRemove: Type: boolean

Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
data: Type: integer

Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
failedQuantity: Type: number

The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
giftDetail: Type: string

String identifying the free gift, usually the repository id of the gift type.
giftType: Type: string

The type of the gift. (sku, product)
key: Type: string

atg.gwp
quantity: Type: number

The total quantity of sku for this gift selection.
removedQuantity: Type: number

The amount of free quantity that has since been manually removed by a Shopper.
selectedQuantity: Type: integer

The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
targetedQuantity: Type: number

The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
value: Type: string

The gift with purchase promotion id

Nested Schema : items

Type: object

amount: Type: number

Amount to be used from the payment group.
balance: Type: number

Total available balance on the gift card.
gatewayName: Type: string

Payment gateway name. e.g. chaseGiftCard.
giftCardNumber: Type: string

Gift card number.
isAmountRemaining: Type: boolean

A boolean to decide if more payment can be made from this payment group.
maskedCardNumber: Type: string

Masked gift card number.
paymentGroupId: Type: string

Payment group id.
paymentMethod: Type: string

Payment method. e.g. physicalGiftCard/ creditCard.
paymentState: Type: string

The state of the payment group. e.g. INITIAL.
uiIntervention: Type: string

This decides whether the client has to do some intervention for payment. e.g. SOP.

Nested Schema : giftWithPurchaseMessages

Type: array

The gift with purchase messages information.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

identifier: Type: string

The pricing message identifier.
params: Type: array params

Additional Properties Allowed:

The list of all message parameters.
priority: Type: integer

The pricing message priority.
summary: Type: string

The pricing message summary.
type: Type: string

The pricing message type.

Nested Schema : params

Type: array

The list of all message parameters.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

promotionId: Type: string

The promotion id.

Nested Schema : errorInfo

Type: array

the array of errors, if any

Type: string

Nested Schema : notes

Type: array

the notes (history) for the order

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

profileId: Type: string

the profile id of the user
profileType: Type: string

the profile type of the user that requested the quote
requestDate/quoteDate/rejectionDate: Type: number

the request/quote/rejection date for the note
requesterNote/providerNote/rejectionNote: Type: string

the requester/provider/rejection note

Nested Schema : frequencyAmountTotals

Type: array

The total for each recurring charge frequency

Type: object items

Additional Properties Allowed:

Nested Schema : frequencyTaxTotals

Type: array

The tax for each recurring charge frequency

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

frequency: Type: string

The frequency for the item's total e.g. Monthly.
total: Type: string

The total amount for the frequency.

Nested Schema : items

Type: object

frequency: Type: string

The frequency for the item's tax e.g. Monthly.
tax: Type: string

The tax amount for the frequency.

Nested Schema : items

Type: object

items: Type: array items

Additional Properties Allowed:

The array of products in the shipping group.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The price information.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.
surcharge: Type: number

The shipping surcharge.

Nested Schema : items

Type: array

The array of products in the shipping group.

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

The price information.

amount: Type: number

The total order amount.
currencyCode: Type: string

The currency code.
shipping: Type: number

The total shipping cost.
shippingSurchargeValue: Type: number

Extra handling costs for shipping the products.
subTotal: Type: number

Sub-total.
tax: Type: number

The total tax amount.
total: Type: number

The order total.

Nested Schema : shippingAddress

Type: object

The shipping address details.

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Country code.
selectedState: Type: string

State code.
state: Type: string

State.
state_ISOCode: Type: string

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

cost: Type: number

The total cost of shipping.
shippingTax: Type: number

The shipping tax.
value: Type: string

The shipping method applied to the order.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
active: Type: boolean

active or not.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

The category to which the product belongs.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
displayName: Type: string

The name of the product.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

Array of custom properties at order line item level.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
price: Type: integer

The actual price of the product.
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

The quantity of the product in the shipping group.
rawTotalPrice: Type: integer

The raw price of the product.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.
skuProperties: Type: array skuProperties

Additional Properties Allowed:

Sku properties Information
unitPrice: Type: integer

The unit price of the product.
variant: Type: array variant

Additional Properties Allowed:

List of variants for the product.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : discountInfo

Type: array

The discount information.

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperties

Type: array

Array of custom properties at order line item level.

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : skuProperties

Type: array

Sku properties Information

Type: object items

Additional Properties Allowed:

Nested Schema : variant

Type: array

List of variants for the product.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

This field returns name of the promotion. Retained for backward compatibility
promotionId: Type: string

The promotion ID.
promotionLongDesc: Type: string

The description of the promotion.
promotionName: Type: string

The display name of the promotion.

Nested Schema : items

Type: object

id: Type: string

The ID of the dynamic property.
label: Type: string

The label of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

id: Type: string

ID of the Dynamic SKU Property.
name: Type: string

Name of the Dynamic SKU Property.
propertyType: Type: string

Type that indicates whether it is a base or a custom SKU property,
value: Type: string

Value of the Dynamic SKU Property.

Nested Schema : items

Type: object

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value.

Nested Schema : items

Type: array

Items in the cart.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

Sku reference id.
childItems: Type: array childItems

Additional Properties Allowed:

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.
commerceItemId: Type: string

The unique line item ID distinguisher.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

Array of custom properties at order line item level.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
giftWithPurchaseCommerceItemMarkers: Type: array giftWithPurchaseCommerceItemMarkers

Additional Properties Allowed:

The array of giftWithPurchaseCommerceItemMarkers.
id: Type: string

Repository id of the commerce item.
price: Type: number

Price of the items.
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

Quantity of the items.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.

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.

Type: object items

Additional Properties Allowed:

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : dynamicProperties

Type: array

Array of custom properties at order line item level.

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseCommerceItemMarkers

Type: array

The array of giftWithPurchaseCommerceItemMarkers.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
amount: Type: integer

The total amount of this item including its child items amounts.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

skuid of the item.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
displayName: Type: string

The name of the product.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
id: Type: string

Repository id of the commerce item.
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

The quantity of the product.
rawTotalPrice: Type: integer

The raw price of the product.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.
unitPrice: Type: integer

The unit price of the product.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a configurator system.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

id: Type: string

The ID of the dynamic property.
label: Type: string

The label of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

actionCode: Type: string

The action code that has been set on the externalData item by the configurator system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

dynamic_property_key: Type: string

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

automaticQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was auto added by pricing.
data: Type: integer

The gift hash code for this gift with purchase promotion.
key: Type: string

atg.gwp
remainingQuantity: Type: number

The quantity of the commerce item that is not affected by gift with purchase.
selectedQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was selected by the shopper.
targetedQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was targeted by pricing.
value: Type: string

The gift with purchase promotion id.

Example application/json


{
    "priceInfo":{
        "amount":37,
        "total":37,
        "shipping":0,
        "shippingSurchargeValue":0,
        "tax":0,
        "subTotal":40,
        "currencyCode":"USD"
    },
    "shippingGroups":[
        {
            "priceInfo":{
                "amount":37,
                "total":37,
                "shipping":0,
                "shippingSurchargeValue":0,
                "tax":0,
                "subTotal":37,
                "currencyCode":"USD",
                "totalWithoutTax":37
            },
            "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"
            },
            "shippingGroupId":"sg10012",
            "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":40,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "commerceItemId":"ci3000411",
                    "assetId":"asset10001",
                    "price":40,
                    "onSale":false,
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "unitPrice":40,
                    "serviceAccountId":"serviceAcc-123",
                    "quantity":1,
                    "productId":"xprod1049",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":40,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":40,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "externalRecurringChargeFrequency":"Monthly",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"xsku1242",
                    "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":40,
                    "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":3,
        "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"
            }
        }
    },
    "pricingMessages":{
        "giftWithPurchaseMessages":[
            {
                "summary":"The cart has qualified for a free gift promotion.",
                "identifier":"GWPQualified",
                "params":"[]",
                "type":"information",
                "priority":"-10"
            }
        ]
    },
    "orderId":"o10001",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "payments":[
        {
            "paymentGroupId":"pg70448",
            "amount":37,
            "balance":"100.0",
            "gatewayName":"chaseGiftCard",
            "giftCardNumber":"6035710988880101071",
            "uiIntervention":null,
            "paymentMethod":"physicalGiftCard",
            "isAmountRemaining":true,
            "paymentState":"INITIAL",
            "maskedCardNumber":"xxxxxxxxxxxxxxx1071"
        }
    ],
    "shoppingCart":{
        "numberOfItems":1,
        "items":[
            {
                "unitPrice":40,
                "serviceAccountId":"serviceAcc-123",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "quantity":1,
                "productId":"xprod1047",
                "externalRecurringCharge":10,
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "externalRecurringChargeFrequency":"Monthly",
                "externalRecurringChargeDuration":"12",
                "catRefId":"xsku1242",
                "commerceItemId":"ci3000411",
                "customerAccountId":"customerAcc-123",
                "price":40,
                "assetId":"asset10001",
                "onSale":true,
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "actionCode":"Add",
                "activationDate":"2017-06-27T15:30:00Z",
                "serviceId":"service-123",
                "recurringCharge":10
            }
        ]
    },
    "siteId":"siteUS",
    "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

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "op": "update",
  "payments": [{
    "amount": "100.0",
    "giftCardNumber": "6035710988880101071",
    "giftCardPin": "",
    "type": "physicalGiftCard"
  }],
  "shoppingCart": {
    "coupons": [
      {
        "code": "coupon1",
        "level": "order",
        "description": "promo1",
        "id": "promo20001",
        "totalAdjustment": -1,
        "status": "claimed"
      },
      {
        "code": "coupon2",
        "level": "",
        "description": "",
        "id": "",
        "status": ""
      }
    ],
    "numberOfItems": 1,
    "items": [{
      "unitPrice": 40,
      "serviceAccountId": "serviceAcc-123",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "quantity": 1,
      "dynamicPropertyMode": "pickup",
      "productId": "xprod1047",
      "externalRecurringCharge": 10,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "externalRecurringChargeFrequency": "Monthly",
      "catRefId": "xsku1242",
      "externalRecurringChargeDuration": "12",
      "customerAccountId": "customerAcc-123",
      "price": 40,
      "assetId": "asset10001",
      "onSale": true,
      "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
    }]
  },
  "id": "o10001",
  "dynamicPropertyShippingInstructions": "Test Instructions"
}

Sample Response Payload returned by endpoint:

{
  "priceInfo": {
    "amount": 37,
    "total": 37,
    "shipping": 0,
    "shippingSurchargeValue": 0,
    "tax": 0,
    "subTotal": 40,
    "currencyCode": "USD"
  },
  "shippingGroups": [{
    "priceInfo": {
      "amount": 37,
      "total": 37,
      "shipping": 0,
      "shippingSurchargeValue": 0,
      "tax": 0,
      "subTotal": 37,
      "currencyCode": "USD",
      "totalWithoutTax": 37
    },
    "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"
    },
    "shippingGroupId": "sg10012",
    "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": 40,
      "returnedQuantity": 0,
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "commerceItemId": "ci3000411",
      "assetId": "asset10001",
      "price": 40,
      "onSale": false,
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized within the shipping group",
      "unitPrice": 40,
      "serviceAccountId": "serviceAcc-123",
      "quantity": 1,
      "productId": "xprod1049",
      "salePrice": 0,
      "detailedItemPriceInfo": [{
        "discounted": false,
        "amount": 40,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 40,
        "currencyCode": "USD"
      }],
      "externalRecurringCharge": 10,
      "externalRecurringChargeFrequency": "Monthly",
      "externalRecurringChargeDuration": "12",
      "catRefId": "xsku1242",
      "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": 40,
      "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": 3,
    "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"
    }}
  },
  "pricingMessages": {"giftWithPurchaseMessages": [{
    "summary": "The cart has qualified for a free gift promotion.",
    "identifier": "GWPQualified",
    "params": "[]",
    "type": "information",
    "priority": "-10"
  }]},
  "orderId": "o10001",
  "dynamicProperties": [{
    "id": "dynamicPropertyShippingInstructions",
    "label": "Shipping Instructions",
    "value": "Test Instructions"
  }],
  "payments": [{
    "paymentGroupId": "pg70448",
    "amount": 37,
    "balance": "100.0",
    "gatewayName": "chaseGiftCard",
    "giftCardNumber": "6035710988880101071",
    "uiIntervention": null,
    "paymentMethod": "physicalGiftCard",
    "isAmountRemaining": true,
    "paymentState": "INITIAL",
    "maskedCardNumber": "xxxxxxxxxxxxxxx1071"
  }],
  "shoppingCart": {
    "numberOfItems": 1,
    "items": [{
      "unitPrice": 40,
      "serviceAccountId": "serviceAcc-123",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "quantity": 1,
      "productId": "xprod1047",
      "externalRecurringCharge": 10,
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "giftWithPurchaseCommerceItemMarkers": [],
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "externalRecurringChargeFrequency": "Monthly",
      "externalRecurringChargeDuration": "12",
      "catRefId": "xsku1242",
      "commerceItemId": "ci3000411",
      "customerAccountId": "customerAcc-123",
      "price": 40,
      "assetId": "asset10001",
      "onSale": true,
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "actionCode": "Add",
      "activationDate": "2017-06-27T15:30:00Z",
      "serviceId": "service-123",
      "recurringCharge": 10
    }]
  },
  "siteId": "siteUS",
  "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"
  }]
}