syncQuote
put
/ccadmin/v1/orders/syncQuote
Sync Quote. This operation is used to synchronize the quote from the external system. The expected fields are commerce items and their external prices, order external price and notes.
Request
Supported Media Types
- application/json
Header Parameters
- X-CCProfileType
-
Type:
stringRequired:trueProfile type of the request
Body Parameter
Root Schema : syncQuote_request
{
"taxPriceInfo":{
"discounted":false,
"cityTax":0,
"amount":6.3,
"countyTax":0.9,
"amountIsFinal":false,
"districtTax":0,
"stateTax":5.4,
"currencyCode":"USD",
"countryTax":0
},
"id":"o10076",
"quoteInfo":{
"providerNote":"10% discount given",
"providerDate":1.409947604E12,
"agentId":"A1234",
"externalId":"T12345",
"expirationDate":1234
},
"externalOrderPriceDetails":{
"externalPrice":100
},
"locale":"en",
"commerceItems":[
{
"quantity":3,
"productId":"prod10021",
"returnedQuantity":0,
"availabilityDate":null,
"externalId":null,
"preOrderQuantity":0,
"catalogRefId":"sku10017",
"configuratorId":"123455",
"priceInfo":{
"discounted":false,
"amount":89.97,
"rawTotalPrice":89.97,
"salePrice":0,
"priceListId":"listPrices",
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":10,
"discountable":true,
"currencyCode":"USD",
"currentPriceDetailsSorted":[
{
"discounted":false,
"amount":89.97,
"quantity":3,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":2,
"size":3
},
"tax":6.3,
"detailedUnitPrice":29.99,
"currencyCode":"USD"
}
],
"listPrice":29.99
},
"recurringChargePriceInfo":{
"discounted":false,
"amount":10,
"rawTotalPrice":10,
"salePrice":0,
"priceListId":null,
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"discounted":false,
"amount":10,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":0
},
"catalogId":null,
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"catalogKey":null,
"productDisplayName":"Wii Classic Controller",
"externalPriceDetails":{
"externalPriceQuantity":1,
"externalPrice":100
},
"id":"ci1000076",
"backOrderQuantity":0,
"commerceItems":[
{
"quantity":1,
"recurringChargePriceInfo":{
"discounted":false,
"amount":10,
"rawTotalPrice":10,
"salePrice":0,
"priceListId":null,
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"discounted":false,
"amount":10,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":0
},
"productId":"prod40001",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"catalogRefId":"sku40001"
},
{
"quantity":1,
"productId":"prod40002",
"catalogRefId":"sku40005"
}
]
}
]
}
- commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed:The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl. - externalOrderPriceDetails
-
Type:
objectexternalOrderPriceDetailsRequired:trueAdditional Properties Allowed:Details about external Order pricing. - id
-
Type:
stringThe ID - locale
-
Type:
stringThe locale in which order submitted. - quoteInfo
-
Type:
objectquoteInfoRequired:trueAdditional Properties Allowed:Details about quote info - taxPriceInfo
-
Type:
objecttaxPriceInfoAdditional Properties Allowed:The tax pricing details for the order.
Nested Schema : commerceItems
Type:
arrayThe commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
Nested Schema : externalOrderPriceDetails
Type:
objectDetails about external Order pricing.
- externalPrice
-
Type:
numberRequired:trueExternal price for this order
Nested Schema : quoteInfo
Type:
objectDetails about quote info
- agentId
-
Type:
stringAgent id - expirationDate
-
Type:
stringRequired:trueExpiration date for this quote - externalId
-
Type:
stringexternal id for this quote - providerNote
-
Type:
stringRequired:trueProvider note for this quote - quoteDate
-
Type:
stringQuote Date for this quote
Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - cityTax
-
Type:
numberThe monetary amount of city tax. - countryTax
-
Type:
numberThe monetary amount of country tax. - countyTax
-
Type:
numberThe monetary amount of county tax. - currencyCode
-
Type:
stringThe three character currency code. - discounted
-
Type:
booleanWhether the price was discounted. - districtTax
-
Type:
numberTax amount for the district. - stateTax
-
Type:
numberTax amount for the state.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - availabilityDate
-
Type:
integerThe availabilityDate for preordered/backordered quantity. - backOrderQuantity
-
Type:
integerThe backordered quantity included. - catalogId
-
Type:
stringThe ID of the catalog which this commerce item references. - catalogKey
-
Type:
stringThe key of the catalog this commerce item references. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - configuratorId
-
Type:
stringConfiguration id for the configurable commerce item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalId
-
Type:
stringAn optional, external ID for this commerce item. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about pricing. - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - id
-
Type:
stringThe internal/native ID for this commerce item. - preOrderQuantity
-
Type:
integerThe preordered quantity included. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:Details about pricing. - productDisplayName
-
Type:
stringThe product's display name. (read-only, obtained from the referenced product) - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - returnedQuantity
-
Type:
integerThe quantity returned. - serviceId
-
Type:
stringThe service ID associated to the current item. - state
-
Type:
stringThe state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships) - stateDetail
-
Type:
stringDetails about the state of this commerce item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about pricing.
- externalPrice
-
Type:
numberExternal price for this commerce item - externalPriceQuantity
-
Type:
integerExternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : priceInfo
Type:
objectDetails about pricing.
- amount
-
Type:
numberThe monetary amount of this order. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quanity discounted. - rawTotalPrice
-
Type:
numberThe raw total price. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceAccountId
-
Type:
stringThe service account ID associated to the current item. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : commerceItems
Type:
arrayNested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this price info.
- highBound
-
Type:
integerThe upper bound of the range this price info covers. - lowBound
-
Type:
integerThe lower bound of the range this price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : syncQuote_response
- commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed:The commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl. - creationTime
-
Type:
integerThe creation time. - externalOrderPriceDetails
-
Type:
objectexternalOrderPriceDetailsRequired:trueAdditional Properties Allowed:Details about external Order pricing. - id
-
Type:
stringThe ID - lastModifiedTime
-
Type:
integerThe last modified time. - locale
-
Type:
stringThe locale in which order submitted. - organizationId
-
Type:
stringThe organization ID. - paymentGroupCount
-
Type:
integerThe number of payment groups. (read-only, value is ignored when updating) - paymentGroups
-
Type:
arraypaymentGroupsAdditional Properties Allowed:The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed. - priceGroupId
-
Type:
stringThe ID of the price group to which the order belongs. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:Pricing information, an instance of OrderPriceInfo. - profile
-
Type:
objectprofileAdditional Properties Allowed:Basic profile information. (read-only) - profileId
-
Type:
stringThe ID of the shopper profile that owns the order. - quoteInfo
-
Type:
objectquoteInfoRequired:trueAdditional Properties Allowed:Details about quote info - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information of the order - salesChannel
-
Type:
stringThe sales channel of this order. default to "default". - shippingGroupCount
-
Type:
integerThe number of shipping groups (read-only, value is ignored when updating). - shippingGroups
-
Type:
arrayshippingGroupsAdditional Properties Allowed:Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address. - siteId
-
Type:
stringThe ID of the site on which the order was placed. - sourceSystem
-
Type:
stringThe system where the order originated. - state
-
Type:
stringThe state of the order. - taxExempt
-
Type:
booleanWhether order is tax-exempt or not. - taxPriceInfo
-
Type:
objecttaxPriceInfoAdditional Properties Allowed:The tax pricing details for the order. - totalCommerceItemCount
-
Type:
integerThe total count of commerce items in the order. (read-only)
Nested Schema : commerceItems
Type:
arrayThe commerce items (sometimes referred to as "line items") represent which actual skus are included in thef order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
Nested Schema : externalOrderPriceDetails
Type:
objectDetails about external Order pricing.
- externalPrice
-
Type:
numberRequired:trueExternal price for this order
Nested Schema : paymentGroups
Type:
arrayThe array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
Nested Schema : priceInfo
Type:
objectPricing information, an instance of OrderPriceInfo.
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - discountAmount
-
Type:
numberThe monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - manualAdjustmentTotal
-
Type:
numberThe monetary total of manual adjustments. - rawSubtotal
-
Type:
numberThe monetary raw subtotal. - shipping
-
Type:
numberThe monetary cost of shipping. - tax
-
Type:
numberMonetary tax amount. - total
-
Type:
numberThe monetary total: amount + shipping + tax. (read-only)
Nested Schema : profile
Type:
objectBasic profile information. (read-only)
-
Type:
stringThe email address - firstName
-
Type:
stringFirst name. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:Default shipping address
Nested Schema : quoteInfo
Type:
objectDetails about quote info
- agentId
-
Type:
stringAgent id - expirationDate
-
Type:
stringRequired:trueExpiration date for this quote - externalId
-
Type:
stringexternal id for this quote - providerNote
-
Type:
stringRequired:trueProvider note for this quote - quoteDate
-
Type:
stringQuote Date for this quote - rejectionDate
-
Type:
stringRejection Date for this quote - rejectionNote
-
Type:
stringRejection note for this quote - requestDate
-
Type:
stringRequest Date for this quote - requesterNote
-
Type:
stringRequestor note for this quote
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information of the order
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - discountAmount
-
Type:
numberThe monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - frequencyAmountTotals
-
Type:
arrayfrequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
arrayfrequencyTaxTotalsAdditional Properties Allowed:The tax for each recurring charge frequency - manualAdjustmentTotal
-
Type:
numberThe monetary total of manual adjustments. - rawSubtotal
-
Type:
numberThe monetary raw subtotal. - shipping
-
Type:
numberThe monetary cost of shipping. - tax
-
Type:
numberMonetary tax amount. - total
-
Type:
numberThe monetary total: amount + shipping + tax. (read-only)
Nested Schema : shippingGroups
Type:
arrayShipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.
Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - cityTax
-
Type:
numberThe monetary amount of city tax. - countryTax
-
Type:
numberThe monetary amount of country tax. - countyTax
-
Type:
numberThe monetary amount of county tax. - currencyCode
-
Type:
stringThe three character currency code. - discounted
-
Type:
booleanWhether the price was discounted. - districtTax
-
Type:
numberTax amount for the district. - stateTax
-
Type:
numberTax amount for the state.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - availabilityDate
-
Type:
integerThe availabilityDate for preordered/backordered quantity. - backOrderQuantity
-
Type:
integerThe backordered quantity included. - catalogId
-
Type:
stringThe ID of the catalog which this commerce item references. - catalogKey
-
Type:
stringThe key of the catalog this commerce item references. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - configuratorId
-
Type:
stringConfiguration id for the configurable commerce item. - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalId
-
Type:
stringAn optional, external ID for this commerce item. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about pricing. - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - id
-
Type:
stringThe internal/native ID for this commerce item. - preOrderQuantity
-
Type:
integerThe preordered quantity included. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:Details about pricing. - productDisplayName
-
Type:
stringThe product's display name. (read-only, obtained from the referenced product) - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - returnedQuantity
-
Type:
integerThe quantity returned. - serviceId
-
Type:
stringThe service ID associated to the current item. - state
-
Type:
stringThe state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships) - stateDetail
-
Type:
stringDetails about the state of this commerce item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about pricing.
- externalPrice
-
Type:
numberExternal price for this commerce item - externalPriceQuantity
-
Type:
integerExternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : priceInfo
Type:
objectDetails about pricing.
- amount
-
Type:
numberThe monetary amount of this order. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quanity discounted. - rawTotalPrice
-
Type:
numberThe raw total price. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the item by the configurator system. - activationDate
-
Type:
stringThe activation date in ISO format. - assetId
-
Type:
stringThe asset ID corresponding to the current item. - catalogRefId
-
Type:
stringThe reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
arraycommerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
stringThe deactivation date in ISO format. - externalData
-
Type:
arrayexternalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
objectexternalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
objectexternalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
stringThe ID of the product. - quantity
-
Type:
integerThe quantity included. - recurringChargePriceInfo
-
Type:
objectrecurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
stringThe service ID associated to the current item.
Nested Schema : commerceItems
Type:
arrayNested Schema : externalData
Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
- externalPrice
-
Type:
numberExternal price of this commerce item - externalPriceQuantity
-
Type:
integerexternal quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
- externalRecurringCharge
-
Type:
numberThe external recurring price. - externalRecurringChargeDuration
-
Type:
stringThe duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
stringThe frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
- amount
-
Type:
numberThe monetary amount of this recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
arraycurrentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
booleanWhether discountable. - discounted
-
Type:
booleanWhether the recurring charge price is discounted. - listPrice
-
Type:
numberThe monetary amount of the list price. - onSale
-
Type:
booleanWhether is on sale. - priceListId
-
Type:
stringThe price list ID used for pricing. - quantityDiscounted
-
Type:
integerThe quantity discounted. - rawTotalPrice
-
Type:
numberThe raw total price of the recurring charge. - salePrice
-
Type:
numberThe sale price - shippingSurcharge
-
Type:
numberExtra handling cost for shipping the product.
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- actionCode
-
Type:
stringThe action code that has been set on the externalData item by the configurator system. - name
-
Type:
stringRequired:trueThe name to be associated with the externalData item. - values
-
Type:
objectvaluesRequired:trueAdditional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
- dynamic_property_key
-
Type:
stringRequired:trueThis property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this price info. - secondaryCurrencyTaxAmount
-
Type:
numberThe tax amount in secondary currency - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this price info.
- highBound
-
Type:
integerThe upper bound of the range this price info covers. - lowBound
-
Type:
integerThe lower bound of the range this price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary amount for the recurring charge. - amountIsFinal
-
Type:
booleanWhether the recurring charge amount is final. - currencyCode
-
Type:
stringThe three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
numberThe detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
booleanWhether the price is discounted. - quantity
-
Type:
integerThe number of items covered by this recurring charge price info - range
-
Type:
objectrangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
numberMonetary tax amount.
Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integerThe upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integerThe lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integerThe number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object- amount
-
Type:
numberRequired:trueThe monetary amount of the payment. - amountAuthorized
-
Type:
numberThe monetary amount authorized. - authorizationStatus
-
Type:
arrayauthorizationStatusAdditional Properties Allowed:Aray of authorization status objects. - creditCardNumber
-
Type:
stringThe last four digits of the credit card number. (only for TokenizedCreditCards) - creditCardType
-
Type:
stringThe type of the credit card. (only for TokenizedCreditCards) - currencyCode
-
Type:
stringThe three character currency code. For example: USD. - expirationDayOfMonth
-
Type:
stringA string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards) - expirationMonth
-
Type:
stringA string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards) - expirationYear
-
Type:
stringA string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards) - externalId
-
Type:
stringThe ID for the payment group in an external system (like the OMS) - externalSourceId
-
Type:
stringThe external source ID, limited to 6 characters. (only for ExternalPaymentGroups) - externalSubtype
-
Type:
stringThe subtype in the external system. Might be "VISA" for a PaymentGroup with an external type of "CreditCard". (only for ExternalPaymentGroups) - externalType
-
Type:
stringThe type in the external system. Might be "StoreCredit", "CreditCard", "Check", etc. (only for ExternalPaymentGroups). - id
-
Type:
stringThe internal ID of the payment group. - paymentGroupClassType
-
Type:
stringRequired:trueThe class type of the payment group. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup". - paymentMethod
-
Type:
stringRequired:trueThe payment method. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup". - PONumber
-
Type:
stringThe purchase order number. - state
-
Type:
stringThe state of this payment group. - stateDetail
-
Type:
stringDetails about the state of this payment group. - submittedDate
-
Type:
stringThe date the payment was submitted. - token
-
Type:
stringThe CyberSource token string. (only for tokenizedCreditCard)
Nested Schema : shippingAddress
Type:
objectDefault shipping address
- address1
-
Type:
stringAddress Line 1. - address2
-
Type:
stringAddress Line 2. - address3
-
Type:
stringAddress Line 3. - city
-
Type:
stringCity. - country
-
Type:
stringCountry. - county
-
Type:
stringName of the county. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - state
-
Type:
stringState.
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
Nested Schema : items
Type:
object- frequency
-
Type:
stringThe frequency for the item's total e.g. Monthly. - total
-
Type:
stringThe total amount for the frequency.
Nested Schema : items
Type:
object- frequency
-
Type:
stringThe frequency for the item's tax e.g. Monthly. - tax
-
Type:
stringThe tax amount for the frequency.
Nested Schema : items
Type:
object- actualShipDate
-
Type:
stringThe actual shipped date of this shipping group. - commerceItemRelationships
-
Type:
arraycommerceItemRelationshipsAdditional Properties Allowed:The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId. - description
-
Type:
stringThe description of this shipping group. Defaults to the ID. - handlingInstructions
-
Type:
arrayhandlingInstructionsAdditional Properties Allowed:Handling instructions. Currently read-only. - id
-
Type:
stringThe ID of this shipping group. - priceInfo
-
Type:
objectpriceInfoAdditional Properties Allowed:The pricing details about this shipping group. - shipOnDate
-
Type:
stringThe date this shipping group is expected to ship upon. - shippingAddress
-
Type:
objectshippingAddressAdditional Properties Allowed:The shipping address for this shipping group. - shippingGroupClassType
-
Type:
stringThe class type for the ShippingGroup. Currently must be "hardgoodShippingGroup". - shippingMethod
-
Type:
stringThe shipping method. - specialInstructions
-
Type:
arrayspecialInstructionsAdditional Properties Allowed:Special instructions for the shipping group. Keys and values are strings. - state
-
Type:
stringThe state of this shipping group. - stateDetail
-
Type:
stringDetails about the state of this shipping group. - submittedDate
-
Type:
stringThe date the shipping group was submitted. - trackingNumber
-
Type:
stringThe tracking number. In case of multiple tracking numbers the format should be carrierId-trackingNumber,carrierId-trackingNumber..., Here carrierId is the Id which has been added through the addCarrier end point.
Nested Schema : commerceItemRelationships
Type:
arrayThe commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
Nested Schema : handlingInstructions
Nested Schema : priceInfo
Type:
objectThe pricing details about this shipping group.
- amount
-
Type:
numberThe monetary amount. - amountIsFinal
-
Type:
booleanWhether the amount is final. - currencyCode
-
Type:
stringThe currency code for the monetary amounts. - discounted
-
Type:
booleanWhether this item is discounted. - rawShipping
-
Type:
numberThe monitary amount of the cost of raw shipping.
Nested Schema : shippingAddress
Type:
objectThe shipping address for this shipping group.
- address1
-
Type:
stringAddress Line 1. - address2
-
Type:
stringAddress Line 2. - address3
-
Type:
stringAddress Line 3. - city
-
Type:
stringCity. - companyName
-
Type:
stringCompany name. - country
-
Type:
stringCountry. - county
-
Type:
stringName of the county. -
Type:
stringThe email address - faxNumber
-
Type:
stringThe fax number. - firstName
-
Type:
stringFirst name. - id
-
Type:
stringID. - jobTitle
-
Type:
stringJob title. - lastName
-
Type:
stringLast name. - middleName
-
Type:
stringMiddle name. - ownerId
-
Type:
stringThe ID of the owner of this address. - phoneNumber
-
Type:
stringPhone number. - postalCode
-
Type:
stringPostal code. - prefix
-
Type:
stringPrefix. - state
-
Type:
stringState. - suffix
-
Type:
stringSuffix.
Nested Schema : specialInstructions
Type:
arraySpecial instructions for the shipping group. Keys and values are strings.
-
Type:
string
Nested Schema : items
Type:
object- amount
-
Type:
numberThe monetary value. - commerceItemExternalId
-
Type:
stringThe referenced commerce item's external ID. - commerceItemId
-
Type:
stringThe referenced commerce item's internal ID. - id
-
Type:
stringThe native ID of this item. - quantity
-
Type:
integerThe quantity of items referenced by this relationship. - relationshipType
-
Type:
stringThe type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING. - returnedQuantity
-
Type:
integerNumber of referenced items that were returned.
Example application/json
{
"priceGroupId":"defaultPriceGroup",
"lastModifiedTime":1.409947606E12,
"creationTime":1.409947604E12,
"sourceSystem":"Cloud Commerce",
"externalOrderPriceDetails":{
"externalPrice":100
},
"locale":"en",
"salesChannel":"default",
"paymentGroups":[
{
"PONumber":"9874",
"expirationYear":"2016",
"amountAuthorized":96.27,
"amount":96.27,
"expirationMonth":"05",
"submittedDate":"2014-09-04T11:46:01.000Z",
"authorizationStatus":[
{
"transactionUuid":"fbd1adb5b1cc40209e8d39324d7f7f6d",
"authorizationDecision":"ACCEPT",
"amount":96.27,
"transactionSuccess":true,
"errorMessage":"Request was processed successfully.",
"currency":"USD",
"reasonCode":"100",
"transactionId":"4098167595050176195662"
}
],
"token":"9997000128471543",
"paymentGroupClassType":"tokenizedCreditCard",
"creditCardNumber":"1111",
"paymentMethod":"tokenizedCreditCard",
"billingAddress":{
"lastName":"FLORES",
"country":"US",
"address3":null,
"city":"Branford",
"address2":null,
"prefix":null,
"address1":"Address Line 1",
"companyName":null,
"jobTitle":null,
"postalCode":"32008",
"county":null,
"suffix":null,
"ownerId":null,
"firstName":"FLORENCE",
"phoneNumber":"12345678",
"faxNumber":null,
"middleName":null,
"state":"FL",
"id":"pg10076",
"email":"FLORENCE.FLORES@test.com"
},
"id":"pg10076",
"currencyCode":"USD"
}
],
"organizationId":"100001",
"relationships":[
{
"paymentGroupId":"pg10076",
"amount":96.27,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r10068"
}
],
"priceInfo":{
"discounted":false,
"amount":89.97,
"total":96.27,
"shipping":0,
"manualAdjustmentTotal":0,
"amountIsFinal":false,
"discountAmount":0,
"tax":6.3,
"rawSubtotal":89.97,
"currencyCode":"USD"
},
"totalCommerceItemCount":3,
"state":"SUBMITTED",
"id":"o10076",
"quoteInfo":{
"providerNote":"10% discount given",
"providerDate":1.409947604E12,
"agentId":"A1234",
"rejectionDate":null,
"requestDate":"2016-09-15T06:59:41.957Z",
"externalId":"T12345",
"rejectionNote":null,
"expirationDate":1234,
"requesterNote":"Please give 15% discount"
},
"commerceItems":[
{
"quantity":3,
"productId":"prod10021",
"returnedQuantity":0,
"availabilityDate":null,
"externalId":null,
"preOrderQuantity":0,
"catalogRefId":"sku10017",
"priceInfo":{
"discounted":false,
"amount":89.97,
"rawTotalPrice":89.97,
"salePrice":0,
"priceListId":"listPrices",
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":10,
"discountable":true,
"currencyCode":"USD",
"currentPriceDetailsSorted":[
{
"discounted":false,
"amount":89.97,
"quantity":3,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":2,
"size":3
},
"tax":6.3,
"detailedUnitPrice":29.99,
"currencyCode":"USD"
}
],
"listPrice":29.99
},
"catalogId":null,
"recurringChargePriceInfo":{
"discounted":false,
"amount":10,
"rawTotalPrice":10,
"salePrice":0,
"priceListId":null,
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"discounted":false,
"amount":10,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":0
},
"catalogKey":null,
"productDisplayName":"Wii Classic Controller",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"externalPriceDetails":{
"externalPriceQuantity":1,
"externalPrice":100
},
"id":"ci1000076",
"backOrderQuantity":0,
"commerceItems":[
{
"quantity":1,
"recurringChargePriceInfo":{
"discounted":false,
"amount":10,
"rawTotalPrice":10,
"salePrice":0,
"priceListId":null,
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currentPriceDetailsSorted":[
{
"discounted":false,
"amount":10,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":10,
"currencyCode":"USD"
}
],
"currencyCode":"USD",
"listPrice":0
},
"productId":"prod40001",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"catalogRefId":"sku40001"
},
{
"quantity":1,
"productId":"prod40002",
"catalogRefId":"sku40005"
}
]
}
],
"taxPriceInfo":{
"discounted":false,
"cityTax":0,
"amount":6.3,
"countyTax":0.9,
"amountIsFinal":false,
"districtTax":0,
"stateTax":5.4,
"currencyCode":"USD",
"countryTax":0
},
"shippingGroups":[
{
"shippingMethod":"freeShippingMethod",
"description":"sg10076",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"amount":0,
"rawShipping":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"shippingAddress":{
"lastName":"FLORES",
"country":"US",
"address3":null,
"city":"Branford",
"address2":null,
"prefix":null,
"address1":"203 Main Street",
"companyName":null,
"jobTitle":null,
"postalCode":"32008",
"county":null,
"suffix":null,
"ownerId":null,
"firstName":"FLORENCE",
"phoneNumber":"9087654321",
"faxNumber":null,
"middleName":null,
"state":"FL",
"id":"sg10076",
"email":"FLORENCE.FLORES@test.com"
},
"commerceItemRelationships":[
{
"commerceItemId":"ci1000076",
"amount":0,
"quantity":3,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"commerceItemExternalId":null,
"id":"r10066"
}
],
"state":"INITIAL",
"id":"sg10076",
"stateDetail":null,
"trackingNumber":null,
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"profile":{
"lastName":"FLORES",
"firstName":"FLORENCE",
"shippingAddress":{
"country":"US",
"phoneNumber":null,
"address3":null,
"address2":null,
"city":"Branford",
"address1":"203 Main Street",
"postalCode":"32008",
"county":null,
"state":null
},
"middleName":null,
"email":"FLORENCE.FLORES@test.com"
},
"shippingGroupCount":1,
"paymentGroupCount":1,
"recurringChargePriceInfo":{
"discounted":false,
"amount":30,
"total":32.4,
"shipping":0,
"subTotalByFrequency":[
{
"amount":30,
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":2.4,
"frequency":"Monthly"
}
],
"manualAdjustmentTotal":0,
"amountIsFinal":false,
"discountAmount":0,
"tax":2.4,
"rawSubtotal":30,
"currencyCode":"USD"
},
"profileId":"se-570031",
"siteId":"siteUS"
}
Default Response
The error response
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Request:
{
"taxPriceInfo": {
"discounted": false,
"cityTax": 0,
"amount": 6.3,
"countyTax": 0.9,
"amountIsFinal": false,
"districtTax": 0,
"stateTax": 5.4,
"currencyCode": "USD",
"countryTax": 0
},
"id": "o10076",
"quoteInfo": {
"providerNote": "10% discount given",
"providerDate": 1409947604000,
"agentId": "A1234",
"externalId": "T12345",
"expirationDate": 1234
},
"externalOrderPriceDetails": {"externalPrice": 100},
"locale": "en",
"commerceItems": [{
"quantity": 3,
"productId": "prod10021",
"returnedQuantity": 0,
"availabilityDate": null,
"externalId": null,
"preOrderQuantity": 0,
"catalogRefId": "sku10017",
"configuratorId": "123455",
"priceInfo": {
"discounted": false,
"amount": 89.97,
"rawTotalPrice": 89.97,
"salePrice": 0,
"priceListId": "listPrices",
"quantityDiscounted": 0,
"amountIsFinal": false,
"onSale": false,
"shippingSurcharge": 10,
"discountable": true,
"currencyCode": "USD",
"currentPriceDetailsSorted": [{
"discounted": false,
"amount": 89.97,
"quantity": 3,
"amountIsFinal": false,
"range": {
"lowBound": 0,
"highBound": 2,
"size": 3
},
"tax": 6.3,
"detailedUnitPrice": 29.99,
"currencyCode": "USD"
}],
"listPrice": 29.99
},
"recurringChargePriceInfo": {
"discounted": false,
"amount": 10,
"rawTotalPrice": 10,
"salePrice": 0,
"priceListId": null,
"quantityDiscounted": 0,
"amountIsFinal": false,
"onSale": false,
"shippingSurcharge": 0,
"discountable": true,
"currentPriceDetailsSorted": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"amountIsFinal": false,
"range": {
"lowBound": 0,
"highBound": 0,
"size": 1
},
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"currencyCode": "USD",
"listPrice": 0
},
"catalogId": null,
"externalRecurringChargeDetails": {
"externalRecurringCharge": 10,
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12"
},
"catalogKey": null,
"productDisplayName": "Wii Classic Controller",
"externalPriceDetails": {
"externalPriceQuantity": 1,
"externalPrice": 100
},
"id": "ci1000076",
"backOrderQuantity": 0,
"commerceItems": [
{
"quantity": 1,
"recurringChargePriceInfo": {
"discounted": false,
"amount": 10,
"rawTotalPrice": 10,
"salePrice": 0,
"priceListId": null,
"quantityDiscounted": 0,
"amountIsFinal": false,
"onSale": false,
"shippingSurcharge": 0,
"discountable": true,
"currentPriceDetailsSorted": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"amountIsFinal": false,
"range": {
"lowBound": 0,
"highBound": 0,
"size": 1
},
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"currencyCode": "USD",
"listPrice": 0
},
"productId": "prod40001",
"externalRecurringChargeDetails": {
"externalRecurringCharge": 10,
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12"
},
"catalogRefId": "sku40001"
},
{
"quantity": 1,
"productId": "prod40002",
"catalogRefId": "sku40005"
}
]
}]
}
Sample Response Payload returned by endpoint:
{
"priceGroupId": "defaultPriceGroup",
"lastModifiedTime": 1409947606000,
"creationTime": 1409947604000,
"sourceSystem": "Cloud Commerce",
"externalOrderPriceDetails": {"externalPrice": 100},
"locale": "en",
"salesChannel": "default",
"paymentGroups": [{
"PONumber": "9874",
"expirationYear": "2016",
"amountAuthorized": 96.27,
"amount": 96.27,
"expirationMonth": "05",
"submittedDate": "2014-09-04T11:46:01.000Z",
"authorizationStatus": [{
"transactionUuid": "fbd1adb5b1cc40209e8d39324d7f7f6d",
"authorizationDecision": "ACCEPT",
"amount": 96.27,
"transactionSuccess": true,
"errorMessage": "Request was processed successfully.",
"currency": "USD",
"reasonCode": "100",
"transactionId": "4098167595050176195662"
}],
"token": "9997000128471543",
"paymentGroupClassType": "tokenizedCreditCard",
"creditCardNumber": "1111",
"paymentMethod": "tokenizedCreditCard",
"billingAddress": {
"lastName": "FLORES",
"country": "US",
"address3": null,
"city": "Branford",
"address2": null,
"prefix": null,
"address1": "Address Line 1",
"companyName": null,
"jobTitle": null,
"postalCode": "32008",
"county": null,
"suffix": null,
"ownerId": null,
"firstName": "FLORENCE",
"phoneNumber": "12345678",
"faxNumber": null,
"middleName": null,
"state": "FL",
"id": "pg10076",
"email": "FLORENCE.FLORES@test.com"
},
"id": "pg10076",
"currencyCode": "USD"
}],
"organizationId": "100001",
"relationships": [{
"paymentGroupId": "pg10076",
"amount": 96.27,
"relationshipType": "ORDERAMOUNTREMAINING",
"id": "r10068"
}],
"priceInfo": {
"discounted": false,
"amount": 89.97,
"total": 96.27,
"shipping": 0,
"manualAdjustmentTotal": 0,
"amountIsFinal": false,
"discountAmount": 0,
"tax": 6.3,
"rawSubtotal": 89.97,
"currencyCode": "USD"
},
"totalCommerceItemCount": 3,
"state": "SUBMITTED",
"id": "o10076",
"quoteInfo": {
"providerNote": "10% discount given",
"providerDate": 1409947604000,
"agentId": "A1234",
"rejectionDate": null,
"requestDate": "2016-09-15T06:59:41.957Z",
"externalId": "T12345",
"rejectionNote": null,
"expirationDate": 1234,
"requesterNote": "Please give 15% discount"
},
"commerceItems": [{
"quantity": 3,
"productId": "prod10021",
"returnedQuantity": 0,
"availabilityDate": null,
"externalId": null,
"preOrderQuantity": 0,
"catalogRefId": "sku10017",
"priceInfo": {
"discounted": false,
"amount": 89.97,
"rawTotalPrice": 89.97,
"salePrice": 0,
"priceListId": "listPrices",
"quantityDiscounted": 0,
"amountIsFinal": false,
"onSale": false,
"shippingSurcharge": 10,
"discountable": true,
"currencyCode": "USD",
"currentPriceDetailsSorted": [{
"discounted": false,
"amount": 89.97,
"quantity": 3,
"amountIsFinal": false,
"range": {
"lowBound": 0,
"highBound": 2,
"size": 3
},
"tax": 6.3,
"detailedUnitPrice": 29.99,
"currencyCode": "USD"
}],
"listPrice": 29.99
},
"catalogId": null,
"recurringChargePriceInfo": {
"discounted": false,
"amount": 10,
"rawTotalPrice": 10,
"salePrice": 0,
"priceListId": null,
"quantityDiscounted": 0,
"amountIsFinal": false,
"onSale": false,
"shippingSurcharge": 0,
"discountable": true,
"currentPriceDetailsSorted": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"amountIsFinal": false,
"range": {
"lowBound": 0,
"highBound": 0,
"size": 1
},
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"currencyCode": "USD",
"listPrice": 0
},
"catalogKey": null,
"productDisplayName": "Wii Classic Controller",
"externalRecurringChargeDetails": {
"externalRecurringCharge": 10,
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12"
},
"externalPriceDetails": {
"externalPriceQuantity": 1,
"externalPrice": 100
},
"id": "ci1000076",
"backOrderQuantity": 0,
"commerceItems": [
{
"quantity": 1,
"recurringChargePriceInfo": {
"discounted": false,
"amount": 10,
"rawTotalPrice": 10,
"salePrice": 0,
"priceListId": null,
"quantityDiscounted": 0,
"amountIsFinal": false,
"onSale": false,
"shippingSurcharge": 0,
"discountable": true,
"currentPriceDetailsSorted": [{
"discounted": false,
"amount": 10,
"quantity": 1,
"amountIsFinal": false,
"range": {
"lowBound": 0,
"highBound": 0,
"size": 1
},
"tax": 0,
"orderDiscountShare": 0,
"detailedUnitPrice": 10,
"currencyCode": "USD"
}],
"currencyCode": "USD",
"listPrice": 0
},
"productId": "prod40001",
"externalRecurringChargeDetails": {
"externalRecurringCharge": 10,
"externalRecurringChargeFrequency": "Monthly",
"externalRecurringChargeDuration": "12"
},
"catalogRefId": "sku40001"
},
{
"quantity": 1,
"productId": "prod40002",
"catalogRefId": "sku40005"
}
]
}],
"taxPriceInfo": {
"discounted": false,
"cityTax": 0,
"amount": 6.3,
"countyTax": 0.9,
"amountIsFinal": false,
"districtTax": 0,
"stateTax": 5.4,
"currencyCode": "USD",
"countryTax": 0
},
"shippingGroups": [{
"shippingMethod": "freeShippingMethod",
"description": "sg10076",
"submittedDate": null,
"priceInfo": {
"discounted": false,
"amount": 0,
"rawShipping": 0,
"amountIsFinal": false,
"currencyCode": "USD"
},
"shipOnDate": null,
"actualShipDate": null,
"specialInstructions": {},
"shippingAddress": {
"lastName": "FLORES",
"country": "US",
"address3": null,
"city": "Branford",
"address2": null,
"prefix": null,
"address1": "203 Main Street",
"companyName": null,
"jobTitle": null,
"postalCode": "32008",
"county": null,
"suffix": null,
"ownerId": null,
"firstName": "FLORENCE",
"phoneNumber": "9087654321",
"faxNumber": null,
"middleName": null,
"state": "FL",
"id": "sg10076",
"email": "FLORENCE.FLORES@test.com"
},
"commerceItemRelationships": [{
"commerceItemId": "ci1000076",
"amount": 0,
"quantity": 3,
"relationshipType": "SHIPPINGQUANTITY",
"returnedQuantity": 0,
"commerceItemExternalId": null,
"id": "r10066"
}],
"state": "INITIAL",
"id": "sg10076",
"stateDetail": null,
"trackingNumber": null,
"handlingInstructions": [],
"shippingGroupClassType": "hardgoodShippingGroup"
}],
"taxExempt": false,
"profile": {
"lastName": "FLORES",
"firstName": "FLORENCE",
"shippingAddress": {
"country": "US",
"phoneNumber": null,
"address3": null,
"address2": null,
"city": "Branford",
"address1": "203 Main Street",
"postalCode": "32008",
"county": null,
"state": null
},
"middleName": null,
"email": "FLORENCE.FLORES@test.com"
},
"shippingGroupCount": 1,
"paymentGroupCount": 1,
"recurringChargePriceInfo": {
"discounted": false,
"amount": 30,
"total": 32.4,
"shipping": 0,
"subTotalByFrequency": [{
"amount": 30,
"frequency": "Monthly"
}],
"taxByFrequency": [{
"amount": 2.4,
"frequency": "Monthly"
}],
"manualAdjustmentTotal": 0,
"amountIsFinal": false,
"discountAmount": 0,
"tax": 2.4,
"rawSubtotal": 30,
"currencyCode": "USD"
},
"profileId": "se-570031",
"siteId": "siteUS"
}