Apply payments
post
/ccstore/v1/orders/current/payments
This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.
Add one or more Physical Gift Card or Store Credit payments to the cart. This will perform a balance enquiry and calculates the amount remaining to be applied. Plus retains the (yet to be authorised) payment in the cart for authorisation during submit.
This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
-
X-CCVisitorId(optional): string
ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.
Root Schema : applyPayments_request
Type:
Show Source
object
-
items(optional):
array items
Payment details for the order.
Example:
{
"items":[
{
"giftCardNumber":"6035718888920014103",
"giftCardPin":"1234",
"billingAddress":{
"lastName":"Bloggs",
"country":"United States",
"address3":"",
"address2":"",
"city":"Florida City",
"prefix":"",
"address1":"111 Florida Dr",
"postalCode":"33034",
"jobTitle":"",
"companyName":"",
"county":"US",
"suffix":"",
"type":"",
"firstName":"Joe",
"phoneNumber":"",
"alias":"",
"faxNumber":"",
"middleName":"",
"state":"FL",
"email":null,
"state_ISOCode":"US-FL"
},
"type":"physicalGiftCard"
}
]
}
Nested Schema : items
Type:
Show Source
object
-
amount(optional):
number
Amount to be authorized from the payment.
-
billingAddress(optional):
object billingAddress
The billing address details.
-
cardCVV(optional):
string
Credit/Debit card secret pin. Payment type:card.
-
cardNumber(optional):
string
Credit/Debit card number used for payment. Payment type:card.
-
cardType(optional):
string
Credit/Debit card type. e.g. visa. Payment type:card.
-
currencyCode(optional):
string
The currency code.
-
customProperties(optional):
object customProperties
Custom object with dynamic properties. This will be passed to the webhook request
-
expiryMonth(optional):
string
Credit/Debit card expiry month. Payment type:card.
-
expiryYear(optional):
string
Credit/Debit card expiry year. Payment type:card.
-
giftCardNumber(optional):
string
Gift card number used for payment. Payment type:physicalGiftCard.
-
giftCardPin(optional):
string
Gift card pin. Payment type:physicalGiftCard.
-
nameOnCard(optional):
string
Name on the credit/debit card. Payment type:card.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type:invoice
-
saveCard(optional):
boolean
Property that determines whether to save this card or not.
-
savedCardId(optional):
string
ID of the saved card
-
storeCreditNumber(optional):
string
Store credit number used for payment. Payment type:storeCredit.
-
type(optional):
string
Payment type: card | invoice | physicalGiftCard | cash | storeCredit | generic | inStorePayment | loyaltyPoints.
Nested Schema : billingAddress
Type:
object
The billing address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country code.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State code.
-
suffix(optional):
string
Name suffix.
Nested Schema : customProperties
Type:
object
Custom object with dynamic properties. This will be passed to the webhook request
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : addPayments_response
Type:
Show Source
object
-
amountRemaining(optional):
number
Amount Remaining
-
embedded(optional):
object embedded
Property to return other embedded objects, like order. This gets included in the payload when query parameter includeOrder is passed as true.
-
orderId(optional):
string
ORder Id
-
paymentResponses(optional):
array paymentResponses
The array of payment responses
-
profileId(optional):
string
Profile ID of the shopper
Nested Schema : embedded
Type:
object
Property to return other embedded objects, like order. This gets included in the payload when query parameter includeOrder is passed as true.
Show Source
-
order(optional):
object order
The current order representation.
Nested Schema : order
Type:
object
The current order representation.
Show Source
-
cartName(optional):
string
Cart name for this order.
-
discountInfo(optional):
object discountInfo
Discount Information
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo(optional):
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers(optional):
array giftWithPurchaseOrderMarkers
giftWithPurchaseOrderMarker information.
-
orderAction(optional):
string
The action performed on the order.
-
orderId(optional):
string
Order ID of the order to remove.
-
priceInfo(optional):
object priceInfo
Price information of the order.
-
priceListGroup(optional):
object priceListGroup
The price list group object.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shippingGroups(optional):
array shippingGroups
The shipping groups for the order.
-
shippingMethod(optional):
object shippingMethod
Shipping Method information of the order.
-
shoppingCart(optional):
object shoppingCart
Shopping cart information.
Nested Schema : discountInfo
Type:
object
Discount Information
Show Source
-
claimedCouponMultiPromotions(optional):
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap(optional):
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount(optional):
number
Order Discount
-
orderImplicitDiscountList(optional):
array orderImplicitDiscountList
Implicit Promotions for the order
-
shippingDiscount(optional):
number
Shipping Discount
-
unclaimedCouponMultiPromotions(optional):
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap(optional):
object unclaimedCouponsMap
The coupons that were not claimed
Nested Schema : dynamicProperties
Type:
array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
array
giftWithPurchaseOrderMarker information.
Show Source
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount(optional):
number
Amount of order.
-
currencyCode(optional):
string
Currency code.
-
primaryCurrencyTotal(optional):
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount(optional):
number
The current total shipping amount in monetry currency
-
secondaryCurrencyShippingSurchargeValue(optional):
number
Extra handling costs for shipping the products in monetry currency.
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal(optional):
number
The current total (sum of shipping and tax)amount in monetry currency
-
shipping(optional):
number
Shipping price of order.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub total.
-
tax(optional):
number
Tax.
-
taxExclusiveAmount(optional):
number
Total excluding shipping and tax in monetary currency
-
total(optional):
number
Total amount of order.
Nested Schema : priceListGroup
Type:
object
The price list group object.
Show Source
-
repositoryId(optional):
string
Repository ID of the price list group.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
Nested Schema : shippingMethod
Type:
object
Shipping Method information of the order.
Show Source
-
cost(optional):
number
Cost of shipping method.
-
secondaryCurrencyShipingAmount(optional):
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount(optional):
number
Shipping tax amount in monetry currency
-
value(optional):
string
Shipping method value.
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
items(optional):
array items
Items in the cart.
-
numberOfItems(optional):
integer
Number of items in the cart.
Nested Schema : claimedCouponMultiPromotions
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
object
The coupons that were claimed.
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
object
The coupons that were not claimed
Show Source
-
couponCode(optional):
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : couponCode
Type:
array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : couponCode
Type:
object
Coupon Code.
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc(optional):
string
Description of the promotion. Retained for backward compatibility.
-
promotionId(optional):
string
The Id of the promotion.
-
promotionLevel(optional):
string
The promotion level.
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseDetail(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftWithPurchaseIdentifier(optional):
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
giftWithPurchaseQuantityAvailableForSelection(optional):
number
gift quantity available for selection
-
giftWithPurchaseType(optional):
string
The type of the gift. (sku, product)
-
promotionId(optional):
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove(optional):
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data(optional):
integer
Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity(optional):
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(optional):
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType(optional):
string
The type of the gift. (sku, product)
-
key(optional):
string
atg.gwp
-
quantity(optional):
number
The total quantity of sku for this gift selection.
-
removedQuantity(optional):
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity(optional):
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity(optional):
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(optional):
string
The gift with purchase promotion id
Nested Schema : frequencyAmountTotals
Type:
array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
frequency(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object
-
email(optional):
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName(optional):
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(optional):
array items
The array of products in the shipping group.
-
lastName(optional):
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName(optional):
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber(optional):
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
shippingAddress(optional):
object shippingAddress
The shipping address details.
-
shippingMethod(optional):
object shippingMethod
The shipping method details for the order.
-
store(optional):
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
type(optional):
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : shippingAddress
Type:
object
The shipping address details.
Show Source
-
address1(optional):
string
Address snippet.
-
address2(optional):
string
Address snippet.
-
address3(optional):
string
Address snippet.
-
alias(optional):
string
Address alias.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
County.
-
email(optional):
string
Email address.
-
faxNumber(optional):
string
Fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
selectedCountry(optional):
string
Country code.
-
selectedState(optional):
string
State code.
-
state(optional):
string
State.
-
state_ISOCode(optional):
string
State ISO code.
-
suffix(optional):
string
Name suffix.
Nested Schema : shippingMethod
Type:
object
The shipping method details for the order.
Show Source
-
cost(optional):
number
The total cost of shipping.
-
shippingMethodDescription(optional):
string
The description of the shipping method.
-
shippingTax(optional):
number
The shipping tax.
-
value(optional):
string
The shipping method applied to the order.
Nested Schema : store
Type:
object
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1(optional):
string
Address line 1 of the store.
-
address2(optional):
string
Address line 2 of the store.
-
address3(optional):
string
Address line 3 of the store.
-
city(optional):
string
The city in which the store resides.
-
country(optional):
string
The country in which the store resides.
-
county(optional):
string
The county in which the store resides.
-
email(optional):
string
The email address of the store.
-
faxNumber(optional):
string
The fax number of the store.
-
hours(optional):
string
The opening hours of the store.
-
locationId(optional):
string
The location id of the store.
-
name(optional):
string
Name of the store.
-
phoneNumber(optional):
string
The phone number of the store.
-
postalCode(optional):
string
The postal code of the store.
-
stateAddress(optional):
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate(optional):
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId(optional):
string
The product variant Id.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate(optional):
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product in this shipping group.
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce Item
-
variant(optional):
array variant
List of variants for the product.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetId(optional):
string
The asset ID corresponding to the current item.
-
assetKey(optional):
string
The assetKey ID associated to the current item.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
Sku reference id.
-
childItems(optional):
array childItems
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(optional):
string
The unique line item ID distinguisher.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
dynamicProperties(optional):
array dynamicProperties
Array of custom properties at order line item level.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
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(optional):
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(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseCommerceItemMarkers(optional):
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information.
-
id(optional):
string
Repository id of the commerce item.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
price(optional):
number
Price of the items.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
Quantity of the items.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
skuProperties(optional):
array skuProperties
Sku properties Information
-
state(optional):
string
state of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
variant(optional):
array variant
List of variants for the product.
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.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
array
giftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (externally configured) or not (externally configured).
-
amount(optional):
integer
The total amount of this item including its child items amounts.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetId(optional):
string
The asset ID corresponding to the current item.
-
assetKey(optional):
string
The assetKey ID associated to the current item.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
billingProfileId(optional):
string
The billing profile ID associated to the current item.
-
catRefId(optional):
string
skuid of the item.
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo(optional):
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
displayName(optional):
string
The name of the product.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice(optional):
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(optional):
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(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
-
id(optional):
string
Repository id of the commerce item.
-
parentAssetKey(optional):
string
The parentAssetKey ID associated to the current item.
-
productId(optional):
string
ID of the product in the cart.
-
quantity(optional):
integer
The quantity of the product.
-
rawTotalPrice(optional):
integer
The raw price of the product.
-
recurringCharge(optional):
number
The recurring charge for the item.
-
rootAssetKey(optional):
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
state(optional):
string
state of the commerce Item
-
transactionDate(optional):
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice(optional):
integer
The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
object
Detailed Item Price Information.
Show Source
-
amount(optional):
number
The monetary amount for the recurring charge.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
- orderDiscountShare(optional): number
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
tax(optional):
number
Monetary tax amount.
Nested Schema : externalData
Type:
array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
name(optional):
string
The name to be associated with the externalData item.
-
values(optional):
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key(optional):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data(optional):
integer
The gift hash code for this gift with purchase promotion.
-
key(optional):
string
atg.gwp
-
remainingQuantity(optional):
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity(optional):
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value(optional):
string
The gift with purchase promotion id.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the Dynamic SKU Property.
-
name(optional):
string
Name of the Dynamic SKU Property.
-
propertyType(optional):
string
Type that indicates whether it is a base or a custom SKU property,
-
value(optional):
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object
-
optionName(optional):
string
The variant option name.
-
optionValue(optional):
string
The variant option value.
Nested Schema : items
Type:
Show Source
object
-
accountId(optional):
string
Account ID for PayU based on Billing Country
-
amount(optional):
number
Amount authorized
-
balance(optional):
number
Balance for GiftCard
-
confirmationUrl(optional):
string
Confirmation URL
-
customPaymentProperties(optional):
object customPaymentProperties
Custom Payment Properties
-
gatewayName(optional):
string
Name of the Gateway used to process the payment
-
giftCardNumber(optional):
string
Gift Card Number
-
id(optional):
string
Id for Paypal
-
intent(optional):
string
Intent for Paypal
-
maskedCardNumber(optional):
string
Masked Gift Card Number
-
merchantId(optional):
string
Merchant ID for PayU
-
message(optional):
string
Error message, if any
-
paymentGroupId(optional):
string
Payment Group ID relevant to the PaymentMethodType
-
paymentId(optional):
string
Payment ID for PayU
-
paymentMethod(optional):
string
Payment Method Used
-
paymentState(optional):
string
Payment State of the payment
-
REDIRECT(optional):
string
Redirect URL for Paypal
-
responseUrl(optional):
string
Response URL
-
savedCardId(optional):
string
Id of the saved card associated with the payment group.
-
signature(optional):
string
Signature for PayU
-
signatureAlgorithm(optional):
string
Signature Algorithm used for PayU
-
sopUrl(optional):
string
URL to be redirected
-
transaction_state(optional):
string
Transaction State for Paypal
-
transactionStatusByQuery(optional):
string
Status of tranaction for PayU
-
type(optional):
string
PaymentMethodType
-
uiIntervention(optional):
string
If UI Intervention required
Nested Schema : customPaymentProperties
Type:
object
Custom Payment Properties
Example Response (application/json)
{
"totalResults":"2",
"offset":"0",
"hasMore":"false",
"limit":"250",
"links":[
{
"method":"PATCH",
"rel":"/rels/updatePayments",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments"
},
{
"method":"GET",
"rel":"last",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments?offset=0&limit=2"
},
{
"method":"POST",
"rel":"/rels/addPayments",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments/add"
},
{
"method":"GET",
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments"
},
{
"method":"GET",
"rel":"canonical",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments"
},
{
"method":"GET",
"rel":"first",
"href":"http://localhost:8080/ccstoreui/v1/orders/current/payments?offset=0&limit=250"
}
],
"items":[
{
"paymentGroupId":"pg230431",
"amount":9.11,
"customPaymentProperties":{
},
"balance":"9.11",
"gatewayName":"demoGenericGiftCardGateway",
"giftCardNumber":"6035718888920014103",
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":false,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxxxxxxxxxxxx4103"
},
{
"paymentGroupId":"pg230433",
"amount":5.88,
"customPaymentProperties":{
},
"balance":"28.61",
"gatewayName":"demoGenericGiftCardGateway",
"giftCardNumber":"987655432",
"paymentMethod":"physicalGiftCard",
"isAmountRemaining":true,
"paymentState":"INITIAL",
"maskedCardNumber":"xxxxx5432"
}
],
"embedded":{
"order":{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":0,
"secondaryCurrencyTaxAmount":0,
"amount":3.76,
"valueAddedTax":0,
"countyTax":1.88,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":1.88,
"countryTax":0
},
"priceInfo":{
"amount":21.99,
"total":50.75,
"lkpValExcludingFreeShip":null,
"shipping":25,
"shippingSurchargeValue":0,
"tax":3.76,
"subTotal":21.99,
"currencyCode":"USD",
"totalWithoutTax":46.99
},
"discountInfo":{
"orderDiscount":0,
"shippingDiscount":0,
"discountDescList":[
]
},
"shippingMethod":{
"secondaryCurrencyTaxAmount":0,
"shippingTax":2,
"cost":25,
"taxIncluded":true,
"taxCode":"",
"value":"standardShippingMethod",
"shippingMethodDescription":"Standard"
},
"shippingGroupId":"sg40413",
"shippingAddress":{
"lastName":"Anderson",
"country":"US",
"address3":null,
"address2":null,
"city":"Syracuse",
"prefix":null,
"address1":"21 Cedar Ave",
"postalCode":"13202",
"companyName":null,
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"faxNumber":null,
"alias":"Home",
"middleName":null,
"state":"NY",
"email":null
},
"type":"hardgoodShippingGroup",
"items":[
{
"rawTotalPrice":21.99,
"returnedQuantity":0,
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"availabilityDate":null,
"externalData":[
],
"discountAmount":0,
"preOrderQuantity":0,
"commerceItemId":"ci3000422",
"price":21.99,
"onSale":false,
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"commerceId":"ci3000422",
"unitPrice":21.99,
"amount":21.99,
"quantity":1,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITYREMAINING",
"productId":"Product_36Exy",
"salePrice":0,
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":21.99,
"quantity":1,
"configurationDiscountShare":0,
"tax":1.76,
"orderDiscountShare":0,
"detailedUnitPrice":21.99,
"currencyCode":"USD"
}
],
"catRefId":"Sku_36Fxy",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"backOrderQuantity":0,
"listPrice":21.99,
"status":"INITIAL"
}
]
}
],
"creationSiteId":"siteUS",
"orderId":"o30413",
"allowAlternateCurrency":false,
"dynamicProperties":[
],
"payments":[
{
"amount":50.75,
"gatewayName":"CS-A",
"cardType":null,
"type":"CyberSource",
"IIN":"411111",
"paymentGroupId":"pg30411",
"customPaymentProperties":{
},
"uiIntervention":null,
"paymentMethod":"tokenizedCreditCard",
"isAmountRemaining":true,
"paymentState":"INITIAL",
"currencyCode":"USD",
"cardNumber":null
}
],
"priceListGroup":{
"isTaxIncluded":false,
"endDate":null,
"displayName":"Default Price Group",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":true,
"isPointsBased":false,
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
},
"deleted":false,
"taxCalculationType":null,
"repositoryId":"defaultPriceGroup",
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"currencyType":null,
"symbol":"$",
"deleted":false,
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"defaultPriceGroup",
"includeAllProducts":true,
"startDate":null
},
"orderAction":"order",
"priceInfo":{
"amount":21.99,
"total":50.75,
"shipping":25,
"shippingSurchargeValue":0,
"tax":3.76,
"subTotal":21.99,
"currencyCode":"USD",
"totalWithoutTax":46.99
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"shoppingCart":{
"numberOfItems":1,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v3838394227481959246/products/girldragontattoo_LARGE.jpg&height=100&width=100",
"rawTotalPrice":21.99,
"displayName":"The Girl with the Dragon Tattoo",
"dynamicProperties":[
],
"shippingSurchargeValue":0,
"discountAmount":0,
"externalData":[
],
"description":"A really great movie that you should not miss.",
"isItemValid":true,
"itemDiscountInfos":[
],
"commerceItemId":"ci3000422",
"price":21.99,
"variant":[
],
"primaryImageAltText":"The Girl with the Dragon Tattoo",
"onSale":false,
"id":"ci3000422",
"state":"Added to order",
"stateKey":"INITIAL",
"unitPrice":21.99,
"primaryImageTitle":"The Girl with the Dragon Tattoo",
"childSKUs":[
{
"primaryThumbImageURL":null
}
],
"amount":21.99,
"quantity":1,
"productId":"Product_36Exy",
"pointOfNoRevision":false,
"salePrice":0,
"orderDiscountInfos":[
],
"detailedItemPriceInfo":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":21.99,
"quantity":1,
"configurationDiscountShare":0,
"tax":1.76,
"orderDiscountShare":0,
"detailedUnitPrice":21.99,
"currencyCode":"USD"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"originalCommerceItemId":null,
"taxCode":null,
"catRefId":"Sku_36Fxy",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"listingSKUId",
"id":"listingSKUId",
"value":null
},
{
"propertyType":"sku-base",
"name":"Not Returnable",
"id":"nonreturnable",
"value":false
},
{
"propertyType":"sku-base",
"name":"Name",
"id":"displayName",
"value":null
},
{
"propertyType":"sku-base",
"name":"Active",
"id":"active",
"value":true
},
{
"propertyType":"sku-base",
"name":"Id",
"id":"id",
"value":"Sku_36Fxy"
},
{
"propertyType":"sku-base",
"name":"Discountable",
"id":"discountable",
"value":true
}
],
"route":"/the-girl-with-the-dragon-tattoo/product/Product_36Exy",
"discountInfo":[
],
"siteId":"siteUS",
"shopperInput":{
},
"asset":false,
"listPrice":21.99
}
]
},
"giftWithPurchaseInfo":[
],
"siteId":"siteUS",
"markers":[
{
"repositoryId":"mark100005",
"value":"78900",
"key":"campaign_eloqua"
}
],
"giftWithPurchaseOrderMarkers":[
]
}
}
}
400 Response
The error response (which alternates to the default response depending on error reason).
Root Schema : errorModelSingleError
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
Default Response
The error response.
Root Schema : errorModelMultiErrors
Type:
Show Source
object
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
status(optional):
string
The HTTP status code
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code