addPayments
post
/ccstore/v1/payment
Add Payments. Add payments to an order.
Request
Supported Media Types
- application/json
Root Schema : addPayments_request
Type:
Show Source
object-
op:
string
operation - inquireBalance - to inquire balance of a GiftCard, initiate - for cash and paypalCehckout
-
orderId(required):
string
The Order ID.
-
payments(required):
array payments
The array of Payments to be applied to the order.
-
profileId:
string
The Profile ID.
Example:
{
"orderId":"o80413",
"profileId":"170309",
"payments":[
{
"amount":"15.50",
"customProperties":{
"cust-prop2":"cust-prop2",
"cust-prop1":"cust-prop1"
},
"giftCardNumber":"536564",
"giftCardPin":"123",
"billingAddress":{
"lastName":"Anderson",
"country":"US",
"address2":"",
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"county":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com (http://example.com/)",
"state_ISOCode":"US-NY"
},
"paymentMethodType":"physicalGiftCard"
},
{
"cardCVV":"333",
"amount":"19.50",
"customProperties":{
"cust-prop2":"cust-prop2",
"cust-prop1":"cust-prop1"
},
"nameOnCard":"Kim",
"cardType":"visa",
"expiryMonth":"3",
"expiryYear":"2019",
"billingAddress":{
"lastName":"Anderson",
"country":"US",
"address2":"",
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"county":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com (http://example.com/)",
"state_ISOCode":"US-NY"
},
"paymentMethodType":"card",
"cardNumber":"4111111111111111"
}
]
}Nested Schema : items
Type:
Show Source
object-
amount(required):
number
Amount to be paid using this paymentMethod.
-
billingAddress:
object billingAddress
The billing address details.
-
billTo:
object billTo
billTo details for invoice payment. Applicable for B2B orders only
-
cardCVV:
string
Credit/Debit card secret pin. PaymentMethodType: card.
-
cardNumber:
string
Credit/Debit card number used for payment. PaymentMethodType: card.
-
cardType:
string
Credit/Debit card type. e.g. visa. PaymentMethodType: card.
-
customProperties:
object customProperties
Additional Properties Allowed: additionalPropertiesCustom object with dynamic properties. This will be passed to the webhook request
-
expiryMonth:
integer
Credit/Debit card expiry month. PaymentMethodType: card.
-
expiryYear:
integer
Credit/Debit card expiry year. PaymentMethodType: card.
-
giftCardNumber:
string
Gift card number used for payment. PaymentMethodType: physicalGiftCard.
-
giftCardPin:
string
Gift card pin. PaymentMethodType: physicalGiftCard.
-
nameOnCard:
string
Name on the credit/debit card. PaymentMethodType: card.
-
nickname:
string
card nickname
-
PayerID:
string
Payer ID relevant to paypal checkout type. PaymentMethodType: paypalCheckout.
-
paymentGroupId:
string
Payment Group ID relevant to the PaymentMethodType. PaymentMethodType: paypalCheckout, payUWebLatamCheckout.
-
paymentId:
string
Payment ID relevant to the PaymentMethodType. PaymentMethodType: paypalCheckout
-
paymentMethodType(required):
string
Payment Method Type - payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard,cash
-
PONumber:
string
Purchase order number for invoice payment. PaymentMethodType: invoice
-
saveCard:
boolean
Property that determines whether to save this card or not.
-
savedCardId:
string
Id of the saved card
-
seqNum:
string
Sequence Number of the payment. In multiple paymnets, there are can be n number of payments.
-
setAsDefault:
boolean
Property to set this card as default card.
-
token:
string
Token relevant to paypal checkout type. PaymentMethodType: paypalCheckout.
Nested Schema : billingAddress
Type:
objectThe billing address details.
Show Source
-
address1(required):
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city(required):
string
City.
-
companyName:
string
Company name.
-
country(required):
string
Country.
-
county:
string
County.
-
email:
string
Email.
-
faxNumber:
string
Fax number.
-
firstName(required):
string
First name.
-
jobTitle:
string
Job title.
-
lastName(required):
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode(required):
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry(required):
string
Country code.
-
selectedState(required):
string
State code.
-
state(required):
string
State.
-
state_ISOCode(required):
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : billTo
Type:
objectbillTo details for invoice payment. Applicable for B2B orders only
Show Source
-
customerAccountId:
string
customer account id, (It corresponds to the billTo-address accountId property)
-
partyId:
string
party id
-
siteUseId:
string
site use id
Nested Schema : customProperties
Type:
objectAdditional Properties Allowed
Show Source
-
string
Dynamic Properties if any
Custom object with dynamic properties. This will be passed to the webhook request
Show Source
-
membershipId:
string
memberShipId of customer. This property need to be sent if loyalty payment method is selected for payment
-
programId:
string
Unique id for loyalty program.This property need to be sent if loyalty payment method is selected for payment
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : addPayments_response
Type:
Show Source
object-
amountRemaining:
string
Amount Remaining
-
embedded:
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:
string
The Order ID.
-
paymentResponses:
array paymentResponses
The array of payment responses
-
profileId:
string
Profile ID of the shopper
Nested Schema : embedded
Type:
objectProperty to return other embedded objects, like order. This gets included in the payload when query parameter includeOrder is passed as true.
Show Source
-
order:
object order
The current order representation.
Nested Schema : order
Type:
objectThe current order representation.
Show Source
-
cartName:
string
Cart name for this order.
-
discountInfo:
object discountInfo
Discount Information
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
giftWithPurchaseInfo:
array giftWithPurchaseInfo
The gift information.
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
giftWithPurchaseOrderMarker information.
-
orderAction:
string
The action performed on the order.
-
orderId:
string
Order ID of the order to remove.
-
priceInfo:
object priceInfo
Price information of the order.
-
priceListGroup:
object priceListGroup
The price list group object.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
shippingGroups:
array shippingGroups
The shipping groups for the order.
-
shippingMethod:
object shippingMethod
Shipping Method information of the order.
-
shoppingCart:
object shoppingCart
Shopping cart information.
Nested Schema : discountInfo
Type:
objectDiscount Information
Show Source
-
claimedCouponMultiPromotions:
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Order Discount
-
orderImplicitDiscountList:
array orderImplicitDiscountList
Implicit Promotions for the order
-
shippingDiscount:
number
Shipping Discount
-
unclaimedCouponMultiPromotions:
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap:
object unclaimedCouponsMap
The coupons that were not claimed
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type:
arraygiftWithPurchaseOrderMarker information.
Show Source
Nested Schema : priceInfo
Type:
objectPrice information of the order.
Show Source
-
amount:
number
Amount of order.
-
currencyCode:
string
Currency code.
-
primaryCurrencyTotal:
number
The current total in loyalty points in case of multi currency
-
secondaryCurrencyShippingAmount:
number
The current total shipping amount in monetry currency
-
secondaryCurrencyShippingSurchargeValue:
number
Extra handling costs for shipping the products in monetry currency.
-
secondaryCurrencyTaxAmount:
number
The current total tax amount in monetry currency
-
secondaryCurrencyTotal:
number
The current total (sum of shipping and tax)amount in monetry currency
-
shipping:
number
Shipping price of order.
-
shippingSurchargeValue:
number
Extra handling costs for shipping the products.
-
subTotal:
number
Sub total.
-
tax:
number
Tax.
-
taxExclusiveAmount:
number
Total excluding shipping and tax in monetary currency
-
total:
number
Total amount of order.
Nested Schema : priceListGroup
Type:
objectThe price list group object.
Show Source
-
repositoryId:
string
Repository ID of the price list group.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals:
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals:
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping:
number
Cost of shipping the product.
-
subTotal:
number
The sub-total price of the recurring charge.
-
tax:
number
Monetary tax amount.
-
total:
number
The total price of the recurring charge.
-
totalWithoutTax:
number
Total of recurring amount without tax included.
Nested Schema : shippingMethod
Type:
objectShipping Method information of the order.
Show Source
-
cost:
number
Cost of shipping method.
-
secondaryCurrencyShipingAmount:
number
shipping amount in monetry currency
-
secondaryCurrencyTaxAmount:
number
Shipping tax amount in monetry currency
-
value:
string
Shipping method value.
Nested Schema : shoppingCart
Type:
objectShopping cart information.
Show Source
-
items:
array items
Items in the cart.
-
numberOfItems:
integer
Number of items in the cart.
Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
object couponCode
Coupon Code.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which promotions were applied
Show Source
Nested Schema : items
Type:
Show Source
object-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
Nested Schema : items
Type:
Show Source
object-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type:
Show Source
object-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
Nested Schema : items
Type:
Show Source
object-
id:
string
The ID of the dynamic property.
-
label:
string
The label of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
giftWithPurchaseDetail:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftWithPurchaseIdentifier:
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:
number
gift quantity available for selection
-
giftWithPurchaseType:
string
The type of the gift. (sku, product)
-
promotionId:
string
The gift with purchase promotion id
Nested Schema : items
Type:
Show Source
object-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
integer
Identifier to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
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:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType:
string
The type of the gift. (sku, product)
-
key:
string
atg.gwp
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
selectedQuantity:
integer
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
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:
string
The gift with purchase promotion id
Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's total e.g. Monthly.
-
total:
string
The total amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's tax e.g. Monthly.
-
tax:
string
The tax amount for the frequency.
Nested Schema : items
Type:
Show Source
object-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName:
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items:
array items
The array of products in the shipping group.
-
lastName:
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName:
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber:
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
shippingAddress:
object shippingAddress
The shipping address details.
-
shippingMethod:
object shippingMethod
The shipping method details for the order.
-
store:
object store
Information about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup
Nested Schema : shippingAddress
Type:
objectThe shipping address details.
Show Source
-
address1:
string
Address snippet.
-
address2:
string
Address snippet.
-
address3:
string
Address snippet.
-
alias:
string
Address alias.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country.
-
county:
string
County.
-
email:
string
Email address.
-
faxNumber:
string
Fax number.
-
firstName:
string
First name.
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Name prefix.
-
selectedCountry:
string
Country code.
-
selectedState:
string
State code.
-
state:
string
State.
-
state_ISOCode:
string
State ISO code.
-
suffix:
string
Name suffix.
Nested Schema : shippingMethod
Type:
objectThe shipping method details for the order.
Show Source
-
cost:
number
The total cost of shipping.
-
shippingMethodDescription:
string
The description of the shipping method.
-
shippingTax:
number
The shipping tax.
-
value:
string
The shipping method applied to the order.
Nested Schema : store
Type:
objectInformation about the Store from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1:
string
Address line 1 of the store.
-
address2:
string
Address line 2 of the store.
-
address3:
string
Address line 3 of the store.
-
city:
string
The city in which the store resides.
-
country:
string
The country in which the store resides.
-
county:
string
The county in which the store resides.
-
email:
string
The email address of the store.
-
faxNumber:
string
The fax number of the store.
-
hours:
string
The opening hours of the store.
-
locationId:
string
The location id of the store.
-
name:
string
Name of the store.
-
phoneNumber:
string
The phone number of the store.
-
postalCode:
string
The postal code of the store.
-
stateAddress:
string
The state in which the store resides.
Nested Schema : items
Type:
Show Source
object-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId:
string
The product variant Id.
-
dynamicProperties:
array dynamicProperties
Array of custom properties at order line item level.
-
pointOfNoRevision:
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preferredPickupDate:
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in this shipping group.
-
skuProperties:
array skuProperties
Sku properties Information
-
state:
string
state of the commerce Item
-
variant:
array variant
List of variants for the product.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : items
Type:
Show Source
object-
id:
string
The ID of the dynamic property.
-
label:
string
The label of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
id:
string
ID of the Dynamic SKU Property.
-
name:
string
Name of the Dynamic SKU Property.
-
propertyType:
string
Type that indicates whether it is a base or a custom SKU property,
-
value:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
The variant option name.
-
optionValue:
string
The variant option value.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey ID associated to the current item.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
Sku reference id.
-
childItems:
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:
string
The unique line item ID distinguisher.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo:
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
dynamicProperties:
array dynamicProperties
Array of custom properties at order line item level.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
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:
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:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
giftWithPurchaseCommerceItemMarker information.
-
id:
string
Repository id of the commerce item.
-
originalCommerceItemId:
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey:
string
The parentAssetKey ID associated to the current item.
-
pointOfNoRevision:
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
price:
number
Price of the items.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
Quantity of the items.
-
recurringCharge:
number
The recurring charge for the item.
-
rootAssetKey:
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
skuProperties:
array skuProperties
Sku properties Information
-
state:
string
state of the commerce Item
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
variant:
array variant
List of variants for the product.
Nested Schema : childItems
Type:
arrayThe 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:
objectDetailed Item Price Information.
Show Source
-
amount:
number
The monetary amount for the recurring charge.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
- orderDiscountShare: number
-
quantity:
integer
The number of items covered by this recurring charge price info
-
tax:
number
Monetary tax amount.
Nested Schema : dynamicProperties
Type:
arrayArray of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
arraygiftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (externally configured) or not (externally configured).
-
amount:
integer
The total amount of this item including its child items amounts.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey ID associated to the current item.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catRefId:
string
skuid of the item.
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
detailedRecurringChargeInfo:
object detailedRecurringChargeInfo
Detailed Item Price Information.
-
displayName:
string
The name of the product.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPrice:
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:
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:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
-
id:
string
Repository id of the commerce item.
-
parentAssetKey:
string
The parentAssetKey ID associated to the current item.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product.
-
rawTotalPrice:
integer
The raw price of the product.
-
recurringCharge:
number
The recurring charge for the item.
-
rootAssetKey:
string
The rootAssetKey ID associated to the current item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
state:
string
state of the commerce Item
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
integer
The unit price of the product.
Nested Schema : detailedRecurringChargeInfo
Type:
objectDetailed Item Price Information.
Show Source
-
amount:
number
The monetary amount for the recurring charge.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
- orderDiscountShare: number
-
quantity:
integer
The number of items covered by this recurring charge price info
-
tax:
number
Monetary tax amount.
Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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:
string
The ID of the dynamic property.
-
label:
string
The label of the dynamic property.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
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:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this gift with purchase promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by gift with purchase.
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The gift with purchase promotion id.
Nested Schema : items
Type:
Show Source
object-
id:
string
ID of the Dynamic SKU Property.
-
name:
string
Name of the Dynamic SKU Property.
-
propertyType:
string
Type that indicates whether it is a base or a custom SKU property,
-
value:
string
Value of the Dynamic SKU Property.
Nested Schema : items
Type:
Show Source
object-
optionName:
string
The variant option name.
-
optionValue:
string
The variant option value.
Nested Schema : items
Type:
Show Source
object-
accountId:
string
Account ID for PayU based on Billing Country
-
amount:
number
Amount authorized
-
balance:
number
Balance for GiftCard
-
confirmationUrl:
string
Confirmation URL
-
customPaymentProperties:
object customPaymentProperties
Custom Payment Properties
-
gatewayName:
string
Name of the Gateway used to process the payment
-
giftCardNumber:
string
Gift Card Number
-
id:
string
Id for Paypal
-
intent:
string
Intent for Paypal
-
maskedCardNumber:
string
Masked Gift Card Number
-
merchantId:
string
Merchant ID for PayU
-
message:
string
Error message, if any
-
paymentGroupId:
string
Payment Group ID relevant to the PaymentMethodType
-
paymentId:
string
Payment ID for PayU
-
paymentMethod:
string
Payment Method Used
-
paymentState:
string
Payment State of the payment
-
REDIRECT:
string
Redirect URL for Paypal
-
responseUrl:
string
Response URL
-
seqNum:
string
Sequence Number of the payment. In multiple paymnets, there are can be any number of payments.
-
signature:
string
Signature for PayU
-
signatureAlgorithm:
string
Signature Algorithm used for PayU
-
sopUrl:
string
URL to be redirected
-
transaction_state:
string
Transaction State for Paypal
-
transactionStatusByQuery:
string
Status of tranaction for PayU
-
type:
string
PaymentMethodType
-
uiIntervention:
string
If UI Intervention required
Nested Schema : customPaymentProperties
Type:
objectCustom Payment Properties
Example Response (application/json)
{
"customPaymentProperties":{
"sample-addnl-property-key2":"sample-payment-property-value2",
"cust-prop2":"cust-prop2",
"cust-prop1":"cust-prop1"
},
"orderId":"o50419",
"profileId":"110093",
"amountRemaining":55,
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/payment"
}
],
"paymentResponses":[
{
"paymentGroupId":"pg50414",
"amount":55,
"gatewayName":"PP-A",
"uiIntervention":"REDIRECT",
"paymentMethod":"onlinePaymentGroup",
"transaction_state":"created",
"id":"PAY-48G29628SF768135MLCM36QI",
"paymentState":"INITIAL",
"type":"paypalCheckout",
"intent":"authorize",
"REDIRECT":"https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-9P504127F4036564D"
}
]
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|51173|Error while processing Payments.|
|51174|Your order has not been placed due to a payment error, and you have not been charged. Please try again.|
|51175|An error occurred completing an order payment.|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code