customCurrency
post
/ccadmin/v1/webhook/customCurrency
This webhook is used for Custom currency Payments
Request
Supported Media Types
- application/json
This webhook is used for Custom currency Payments
Root Schema : customCurrency_request
Type:
objectThis webhook is used for Custom currency Payments
Show Source
-
amount(optional):
string
amount.
-
billingAddress(optional):
object billingAddress
billing address details
-
channel(optional):
string
channel
-
currencyCode(optional):
string
The three character currency code.
-
customProperties(optional):
object customProperties
key value pair of custom attributes
-
gatewayId(optional):
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
gatewaySettings(optional):
object gatewaySettings
Additional Properties Allowed:
truekey value pair of gateway settings -
locale(optional):
string
locale
-
loyaltyDetails(optional):
array loyaltyDetails
profile loyalty programs
-
order(optional):
object order
The current order representation.
-
orderId(optional):
string
Order Id
-
paymentId(optional):
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod(optional):
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
profile(optional):
object profile
Basic profile information.
-
profileDetails(optional):
object profile
-
referenceInfo(optional):
object referenceInfo
-
referenceInfos(optional):
array referenceInfos
-
retryPaymentCount(optional):
number
The number of times payment has been retried for order
-
shippingAddress(optional):
object shippingAddress
Default shipping address
-
siteId(optional):
string
site associated with this request
-
siteURL(optional):
string
site url where order is being placed
-
transactionId(optional):
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp(optional):
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType(optional):
string
type of transaction
Example:
{
"loyaltyDetails":[
{
"programName":"programForFlyer",
"membershipId":"member0002",
"programId":"prg10002",
"status":"Enrolled"
},
{
"programName":"programForYoungster",
"membershipId":"member0001",
"programId":"prg10001",
"status":"Enrolled"
}
],
"orderId":"o30417",
"profile":{
"phoneNumber":"1234512345",
"id":"110072",
"email":"a@a.com"
},
"channel":"storefront",
"locale":"en",
"transactionId":"o30417-pg30418-1504691722253",
"transactionTimestamp":"2017-09-06T09:55:22+0000",
"transactionType":"0600",
"customProperties":{
"cust-prop2":"cust-prop2",
"cust-prop1":"cust-prop1"
},
"paymentId":"pg30418",
"gatewaySettings":{
"paymentMethodTypes":"loyaltyPoints"
},
"paymentMethod":"loyaltyPoints",
"shippingAddress":{
"lastName":"a",
"country":"US",
"firstName":"a",
"phoneNumber":"1234512345",
"address2":null,
"city":"cambridge",
"address1":"1 main st",
"postalCode":"02142",
"state":"MA",
"email":"a@a.com"
},
"siteId":"siteUS",
"currencyCode":"PTS",
"gatewayId":"demoLoyaltyPointsPaymentGateway"
}Nested Schema : billingAddress
Type:
objectbilling address details
Show Source
-
address1(optional):
string
The 1st line of address field
-
address2(optional):
string
The 2nd line of address field
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
The city of the customer
-
companyName(optional):
string
Company name.
-
country(optional):
string
The country of the customer
-
county(optional):
string
Name of the county.
-
dynamicProperties(optional):
array dynamicProperties
Dynamic properties list
-
email(optional):
string
The email of the customer
-
faxNumber(optional):
string
The fax number.
-
firstName(optional):
string
The first name of the customer
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
The last name of customer
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
The phone number of the customer
-
postalCode(optional):
string
The postal code
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
-
suffix(optional):
string
Name suffix.
Nested Schema : customProperties
Type:
objectkey value pair of custom attributes
Show Source
-
membershipId(optional):
string
memberShipId of customer.
-
programId(optional):
string
Unique id for loyalty program.
-
programName(optional):
string
programName of Loyalty Program
Nested Schema : gatewaySettings
Type:
objectAdditional Properties Allowed:
true key value pair of gateway settings
Nested Schema : order
Type:
objectThe 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 : profile
Type:
objectBasic profile information.
Show Source
-
email(optional):
string
The email address
-
id(optional):
string
The ID of the shopper profile that owns the order.
-
phoneNumber(optional):
string
Phone number.
Nested Schema : profile
Type:
Show Source
object-
currentOrganization(optional):
object organization
-
email(optional):
string
The email address of the profile
-
firstName(optional):
string
The first name of the profile
-
id(optional):
string
Id
-
lastName(optional):
string
The last name of the profile
-
lastPasswordUpdate(optional):
string(date-time)
Password update date
-
middleName(optional):
string
The middle name of the profile
-
parentOrganization(optional):
object organization
-
profileType(optional):
string
The type of profile
-
receiveEmail(optional):
string
The string representation of whether the user wants to recieve email or not
-
registrationDate(optional):
string(date-time)
Registration date
-
secondaryOrganizations(optional):
array secondaryOrganizations
List of secondary organizations that need to associate with the user.
-
taxExempt(optional):
boolean
if tax is exempted
-
taxExemptionCode(optional):
string
Tax exemption code
Nested Schema : referenceInfo
Type:
Show Source
object-
amount(optional):
string
amount.
-
currencyCode(optional):
string
The three character currency code.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
locale(optional):
string
locale
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
Nested Schema : shippingAddress
Type:
objectDefault shipping address
Show Source
-
address1(optional):
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Name of the country.
-
county(optional):
string
Name of the county.
-
dynamicProperties(optional):
array dynamicProperties
Dynamic properties list
-
email(optional):
string
-
faxNumber(optional):
string
The fax number.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
The last name of customer
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Name prefix.
-
state(optional):
string
State.
-
suffix(optional):
string
Name suffix.
Nested Schema : items
Type:
Show Source
object-
membershipId(optional):
string
membershipId of the profile.
-
programId(optional):
string
programId of Loyalty Program
-
programName(optional):
string
programName of Loyalty Program
-
status(optional):
string
status of Enrollment.
Nested Schema : discountInfo
Type:
objectDiscount 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:
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(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:
objectThe price list group object.
Show Source
-
repositoryId(optional):
string
Repository ID of the price list group.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring 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:
objectShipping 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:
objectShopping 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:
objectThe coupons that were claimed
Show Source
-
coupon code(optional):
array coupon code
Coupon Code, corresponding to which promotions were applied
Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed
Show Source
-
coupon code(optional):
object coupon code
Coupon Code
Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
coupon code(optional):
array coupon code
Coupon Code, corresponding to which some promotions were not applied
Nested Schema : unclaimedCouponsMap
Type:
objectThe coupons that were not claimed
Show Source
-
coupon code(optional):
object coupon code
Coupon Code
Nested Schema : coupon code
Type:
arrayCoupon 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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion Id
-
promotionLevel(optional):
string
Promotion Level
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Adjustment done by the promotion
Nested Schema : coupon code
Type:
objectCoupon Code
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions)
-
promotionDesc(optional):
string
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion Id
-
promotionLevel(optional):
string
Promotion Level
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
-
totalAdjustment(optional):
number
Adjustment done 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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion Id
-
promotionLevel(optional):
string
Promotion Level
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : coupon code
Type:
arrayCoupon 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
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion Id
-
promotionLevel(optional):
string
Promotion Level
-
promotionLongDesc(optional):
string
The description of the promotion.
-
promotionName(optional):
string
The display name of the promotion.
Nested Schema : coupon code
Type:
objectCoupon Code
Show Source
-
external(optional):
boolean
States whether this promotion was applied by an external system (only present on external promotions)
-
promotionDesc(optional):
string
This field returns name of the promotion. Retained for backward compatibility
-
promotionId(optional):
string
Promotion Id
-
promotionLevel(optional):
string
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:
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(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:
objectThe 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:
objectThe 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:
objectInformation 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:
arrayArray 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:
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(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:
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(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:
objectDetailed 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:
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(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:
objectThe 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:
objectThe 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 : organization
Type:
Show Source
object-
contract(optional):
object contract
-
description(optional):
string
Description of the Organization
-
id(optional):
string
The Organization Id
-
name(optional):
string
Name of the Organization
Nested Schema : secondaryOrganizations
Type:
arrayList of secondary organizations that need to associate with the user.
Show Source
Nested Schema : contract
Type:
Show Source
object-
description(optional):
string
Description name of the contract
-
displayName(optional):
string
Display name of the contract
-
id(optional):
string
The contract Id
Nested Schema : items
Type:
Show Source
object-
amount(optional):
string
amount.
-
currencyCode(optional):
string
The three character currency code.
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
locale(optional):
string
locale
-
merchantTransactionId(optional):
string
The transaction ID returned by the merchant. Mandatory attribute.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : customCurrency_response
Type:
Show Source
object-
amount(optional):
string
amount.
-
authorizationResponse(optional):
object authorizationResponse
-
channel:
string
channel
-
creditResponse(optional):
object creditResponse
-
currencyCode:
string
The three character currency code.
-
gatewayId:
string
Reflects the same gateway ID of the corresponding request. Mandatory attribute.
-
inquireBalanceResponse(optional):
object inquireBalanceResponse
-
locale:
string
locale
-
orderId:
string
order id
-
paymentId:
string
Reflects the same paymentId of the corresponding request. Mandatory attribute.
-
paymentMethod:
string
Reflects the same payment method of the corresponding request. Mandatory attribute.
-
siteId:
string
site associated with this request
-
transactionId:
string
Reflects the same transaction ID of the corresponding request. Mandatory attribute.
-
transactionTimestamp:
string
Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
-
transactionType:
string
transaction type
-
voidResponse(optional):
object voidResponse
Nested Schema : creditResponse
Type:
Show Source
object-
additionalProperties(optional):
object additionalProperties
key value pair of additional attributes
-
customPaymentProperties(optional):
object customPaymentProperties
key value pair of custom attributes
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The timestamp of the transaction.
-
merchantTransactionId:
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp:
string
The merchant timestamp of the transaction. Mandatory attribute.
-
responseCode:
string
Returned code of response. Mandatory attribute.
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason:
string
Response reason. Optional attribute
Nested Schema : inquireBalanceResponse
Type:
Show Source
object-
additionalProperties(optional):
object additionalProperties
key value pair of additional attributes
-
customPaymentProperties(optional):
object customPaymentProperties
key value pair of custom attributes
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The timestamp of the transaction.
-
loyaltyPrograms:
array loyaltyPrograms
-
merchantTransactionId:
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp:
string
The merchant timestamp of the transaction. Mandatory attribute.
-
responseCode:
string
Returned code of response. Mandatory attribute.
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason:
string
Response reason. Optional attribute
Nested Schema : voidResponse
Type:
Show Source
object-
additionalProperties(optional):
object additionalProperties
key value pair of additional attributes
-
customPaymentProperties(optional):
object customPaymentProperties
key value pair of custom attributes
-
hostTransactionId(optional):
string
The transaction ID returned by the gateway
-
hostTransactionTimestamp(optional):
string
The timestamp of the transaction.
-
merchantTransactionId:
string
The transaction ID returned by the merchant. Mandatory attribute.
-
merchantTransactionTimestamp:
string
The merchant timestamp of the transaction. Mandatory attribute.
-
responseCode:
string
Returned code of response. Mandatory attribute.
-
responseDescription(optional):
string
The description of the response. Optional attribute
-
responseReason:
string
Response reason. Optional attribute
Nested Schema : additionalProperties
Type:
object key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type:
object key value pair of custom attributes
Show Source
Nested Schema : additionalProperties
Type:
object key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type:
object key value pair of custom attributes
Show Source
Nested Schema : items
Type:
Show Source
object-
additionalProperties(optional):
object additionalProperties
key value pair of additional attributes
-
loyaltyPointDetails:
array loyaltyPointDetails
-
membershipId:
string
membershipId of the profile.
-
programId:
string
programId of Loyalty Program
-
programName:
string
programName of Loyalty Program
Nested Schema : additionalProperties
Type:
object key value pair of additional attributes
Show Source
Nested Schema : items
Type:
Show Source
object-
additionalProperties(optional):
object additionalProperties
key value pair of additional attributes
-
membershipType:
string
membership type
-
pointsBalance:
string
available points balance
-
pointsType:
string
points type
Nested Schema : additionalProperties
Type:
object key value pair of additional attributes
Show Source
Nested Schema : additionalProperties
Type:
object key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type:
object key value pair of custom attributes
Show Source
Example Response (application/json)
{
"transactionType":"0600",
"orderId":"o30417",
"paymentId":"pg30418",
"channel":"storefront",
"paymentMethod":"loyaltyPoints",
"siteId":"siteUS",
"locale":"en",
"inquireBalanceResponse":{
"hostTransactionTimestamp":"1504691722267",
"responseReason":"inquireBalanceResponseReason",
"customPaymentProperties":[
"5000addnl-property-key5",
"cust-prop2",
"5000addnl-property-key2",
"cust-prop1"
],
"responseDescription":"inquireBalanceResponseDescription",
"loyaltyPrograms":[
{
"loyaltyPointDetails":[
{
"membershipType":"blue",
"pointsBalance":"2000",
"pointsType":"bluePoints",
"additionalProperties":{
"propertyName1":"value1",
"propertyName2":"value2"
}
},
{
"membershipType":"red",
"pointsBalance":"6000",
"pointsType":"redPoints",
"additionalProperties":{
"propertyName4":"value4",
"propertyName3":"value3"
}
},
{
"membershipType":"green",
"pointsBalance":"6000",
"pointsType":"PTS",
"additionalProperties":{
"propertyName4":"value4",
"propertyName3":"value3"
}
}
],
"programName":"programForYoungster",
"membershipId":"member0001",
"additionalProperties":{
"propertyName5":"value5",
"validTill":"2029-11-26T15:57:55.631Z",
"propertyName6":"value6",
"validFrom":"2017-07-14T15:57:55.631Z"
},
"programId":"prg10001"
},
{
"loyaltyPointDetails":[
{
"membershipType":"silver",
"pointsBalance":"2000",
"pointsType":"rewardPoints",
"additionalProperties":{
"propertyName7":"value7",
"propertyName8":"value8"
}
},
{
"membershipType":"gold",
"pointsBalance":"6000",
"pointsType":"skyMiles",
"additionalProperties":{
"propertyName10":"value10",
"propertyName9":"value9"
}
}
],
"programName":"programForFlyer",
"membershipId":"member0002",
"additionalProperties":{
"validTill":"2030-12-26T15:57:55.631Z",
"propertyName12":"value12",
"propertyName11":"value11",
"validFrom":"2017-06-14T15:57:55.631Z"
},
"programId":"prg10002"
}
],
"merchantTransactionId":"MERCH-TX-1504691722267",
"hostTransactionId":"HOST-TX-1504691722267",
"additionalProperties":{
"5000addnl-property-key5":"5000payment-property-value5",
"5000addnl-property-key4":"5000payment-property-value4",
"5000addnl-property-key3":"5000payment-property-value3",
"cust-prop2":"cust-prop2",
"5000addnl-property-key2":"5000payment-property-value2",
"cust-prop1":"cust-prop1",
"5000addnl-property-key1":"5000payment-property-value1"
},
"responseCode":"5000",
"merchantTransactionTimestamp":"1504691722267"
},
"currencyCode":"PTS",
"transactionId":"o30417-pg30418-1504691722253",
"transactionTimestamp":"2017-09-06T09:55:22+0000",
"gatewayId":"demoLoyaltyPointsPaymentGateway"
}