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:
string
Required:true
Profile 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:
array
commerceItemsAdditional 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:
object
externalOrderPriceDetailsRequired:true
Additional Properties Allowed:Details about external Order pricing. - id
-
Type:
string
The ID - locale
-
Type:
string
The locale in which order submitted. - quoteInfo
-
Type:
object
quoteInfoRequired:true
Additional Properties Allowed:Details about quote info - taxPriceInfo
-
Type:
object
taxPriceInfoAdditional Properties Allowed:The tax pricing details for the order.
Nested Schema : commerceItems
Type:
array
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.
Nested Schema : externalOrderPriceDetails
Type:
object
Details about external Order pricing.
- externalPrice
-
Type:
number
Required:true
External price for this order
Nested Schema : quoteInfo
Type:
object
Details about quote info
- agentId
-
Type:
string
Agent id - expirationDate
-
Type:
string
Required:true
Expiration date for this quote - externalId
-
Type:
string
external id for this quote - providerNote
-
Type:
string
Required:true
Provider note for this quote - quoteDate
-
Type:
string
Quote Date for this quote
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - currencyCode
-
Type:
string
The three character currency code. - discounted
-
Type:
boolean
Whether the price was discounted. - districtTax
-
Type:
number
Tax amount for the district. - stateTax
-
Type:
number
Tax amount for the state.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - availabilityDate
-
Type:
integer
The availabilityDate for preordered/backordered quantity. - backOrderQuantity
-
Type:
integer
The backordered quantity included. - catalogId
-
Type:
string
The ID of the catalog which this commerce item references. - catalogKey
-
Type:
string
The key of the catalog this commerce item references. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - configuratorId
-
Type:
string
Configuration id for the configurable commerce item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalId
-
Type:
string
An optional, external ID for this commerce item. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about pricing. - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - id
-
Type:
string
The internal/native ID for this commerce item. - preOrderQuantity
-
Type:
integer
The preordered quantity included. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:Details about pricing. - productDisplayName
-
Type:
string
The product's display name. (read-only, obtained from the referenced product) - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - returnedQuantity
-
Type:
integer
The quantity returned. - serviceId
-
Type:
string
The service ID associated to the current item. - state
-
Type:
string
The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships) - stateDetail
-
Type:
string
Details about the state of this commerce item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about pricing.
- externalPrice
-
Type:
number
External price for this commerce item - externalPriceQuantity
-
Type:
integer
External quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : priceInfo
Type:
object
Details about pricing.
- amount
-
Type:
number
The monetary amount of this order. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quanity discounted. - rawTotalPrice
-
Type:
number
The raw total price. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceAccountId
-
Type:
string
The service account ID associated to the current item. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : commerceItems
Type:
array
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this price info.
- highBound
-
Type:
integer
The upper bound of the range this price info covers. - lowBound
-
Type:
integer
The lower bound of the range this price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The 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:
array
commerceItemsAdditional 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:
integer
The creation time. - externalOrderPriceDetails
-
Type:
object
externalOrderPriceDetailsRequired:true
Additional Properties Allowed:Details about external Order pricing. - id
-
Type:
string
The ID - lastModifiedTime
-
Type:
integer
The last modified time. - locale
-
Type:
string
The locale in which order submitted. - organizationId
-
Type:
string
The organization ID. - paymentGroupCount
-
Type:
integer
The number of payment groups. (read-only, value is ignored when updating) - paymentGroups
-
Type:
array
paymentGroupsAdditional 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:
string
The ID of the price group to which the order belongs. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:Pricing information, an instance of OrderPriceInfo. - profile
-
Type:
object
profileAdditional Properties Allowed:Basic profile information. (read-only) - profileId
-
Type:
string
The ID of the shopper profile that owns the order. - quoteInfo
-
Type:
object
quoteInfoRequired:true
Additional Properties Allowed:Details about quote info - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information of the order - salesChannel
-
Type:
string
The sales channel of this order. default to "default". - shippingGroupCount
-
Type:
integer
The number of shipping groups (read-only, value is ignored when updating). - shippingGroups
-
Type:
array
shippingGroupsAdditional 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:
string
The ID of the site on which the order was placed. - sourceSystem
-
Type:
string
The system where the order originated. - state
-
Type:
string
The state of the order. - taxExempt
-
Type:
boolean
Whether order is tax-exempt or not. - taxPriceInfo
-
Type:
object
taxPriceInfoAdditional Properties Allowed:The tax pricing details for the order. - totalCommerceItemCount
-
Type:
integer
The total count of commerce items in the order. (read-only)
Nested Schema : commerceItems
Type:
array
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.
Nested Schema : externalOrderPriceDetails
Type:
object
Details about external Order pricing.
- externalPrice
-
Type:
number
Required:true
External price for this order
Nested Schema : paymentGroups
Type:
array
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.
Nested Schema : priceInfo
Type:
object
Pricing information, an instance of OrderPriceInfo.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - discountAmount
-
Type:
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - manualAdjustmentTotal
-
Type:
number
The monetary total of manual adjustments. - rawSubtotal
-
Type:
number
The monetary raw subtotal. - shipping
-
Type:
number
The monetary cost of shipping. - tax
-
Type:
number
Monetary tax amount. - total
-
Type:
number
The monetary total: amount + shipping + tax. (read-only)
Nested Schema : profile
Type:
object
Basic profile information. (read-only)
-
Type:
string
The email address - firstName
-
Type:
string
First name. - lastName
-
Type:
string
Last name. - middleName
-
Type:
string
Middle name. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:Default shipping address
Nested Schema : quoteInfo
Type:
object
Details about quote info
- agentId
-
Type:
string
Agent id - expirationDate
-
Type:
string
Required:true
Expiration date for this quote - externalId
-
Type:
string
external id for this quote - providerNote
-
Type:
string
Required:true
Provider note for this quote - quoteDate
-
Type:
string
Quote Date for this quote - rejectionDate
-
Type:
string
Rejection Date for this quote - rejectionNote
-
Type:
string
Rejection note for this quote - requestDate
-
Type:
string
Request Date for this quote - requesterNote
-
Type:
string
Requestor note for this quote
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information of the order
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - discountAmount
-
Type:
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - frequencyAmountTotals
-
Type:
array
frequencyAmountTotalsAdditional Properties Allowed:The total for each recurring charge frequency - frequencyTaxTotals
-
Type:
array
frequencyTaxTotalsAdditional Properties Allowed:The tax for each recurring charge frequency - manualAdjustmentTotal
-
Type:
number
The monetary total of manual adjustments. - rawSubtotal
-
Type:
number
The monetary raw subtotal. - shipping
-
Type:
number
The monetary cost of shipping. - tax
-
Type:
number
Monetary tax amount. - total
-
Type:
number
The monetary total: amount + shipping + tax. (read-only)
Nested Schema : shippingGroups
Type:
array
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.
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - cityTax
-
Type:
number
The monetary amount of city tax. - countryTax
-
Type:
number
The monetary amount of country tax. - countyTax
-
Type:
number
The monetary amount of county tax. - currencyCode
-
Type:
string
The three character currency code. - discounted
-
Type:
boolean
Whether the price was discounted. - districtTax
-
Type:
number
Tax amount for the district. - stateTax
-
Type:
number
Tax amount for the state.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - availabilityDate
-
Type:
integer
The availabilityDate for preordered/backordered quantity. - backOrderQuantity
-
Type:
integer
The backordered quantity included. - catalogId
-
Type:
string
The ID of the catalog which this commerce item references. - catalogKey
-
Type:
string
The key of the catalog this commerce item references. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - configuratorId
-
Type:
string
Configuration id for the configurable commerce item. - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalId
-
Type:
string
An optional, external ID for this commerce item. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about pricing. - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - id
-
Type:
string
The internal/native ID for this commerce item. - preOrderQuantity
-
Type:
integer
The preordered quantity included. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:Details about pricing. - productDisplayName
-
Type:
string
The product's display name. (read-only, obtained from the referenced product) - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - returnedQuantity
-
Type:
integer
The quantity returned. - serviceId
-
Type:
string
The service ID associated to the current item. - state
-
Type:
string
The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships) - stateDetail
-
Type:
string
Details about the state of this commerce item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about pricing.
- externalPrice
-
Type:
number
External price for this commerce item - externalPriceQuantity
-
Type:
integer
External quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : priceInfo
Type:
object
Details about pricing.
- amount
-
Type:
number
The monetary amount of this order. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quanity discounted. - rawTotalPrice
-
Type:
number
The raw total price. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the item by the configurator system. - activationDate
-
Type:
string
The activation date in ISO format. - assetId
-
Type:
string
The asset ID corresponding to the current item. - catalogRefId
-
Type:
string
The reference ID of the catalog this commerce item references. Typically the SKU id. - commerceItems
-
Type:
array
commerceItemsAdditional Properties Allowed: - deactivationDate
-
Type:
string
The deactivation date in ISO format. - externalData
-
Type:
array
externalDataAdditional Properties Allowed:External data to be associated with a commerce item, provided by a configurator system. - externalPriceDetails
-
Type:
object
externalPriceDetailsAdditional Properties Allowed:Details about external pricing - externalRecurringChargeDetails
-
Type:
object
externalRecurringChargeDetailsAdditional Properties Allowed:Details about external recurring pricing. - productId
-
Type:
string
The ID of the product. - quantity
-
Type:
integer
The quantity included. - recurringChargePriceInfo
-
Type:
object
recurringChargePriceInfoAdditional Properties Allowed:Recurring charge price information. - serviceId
-
Type:
string
The service ID associated to the current item.
Nested Schema : commerceItems
Type:
array
Nested Schema : externalData
Nested Schema : externalPriceDetails
Type:
object
Details about external pricing
- externalPrice
-
Type:
number
External price of this commerce item - externalPriceQuantity
-
Type:
integer
external quantity of this commerce item
Nested Schema : externalRecurringChargeDetails
Type:
object
Details about external recurring pricing.
- externalRecurringCharge
-
Type:
number
The external recurring price. - externalRecurringChargeDuration
-
Type:
string
The duration for the recurring charge e.g. 12 months. - externalRecurringChargeFrequency
-
Type:
string
The frequency for the recurring charge e.g. Monthly.
Nested Schema : recurringChargePriceInfo
Type:
object
Recurring charge price information.
- amount
-
Type:
number
The monetary amount of this recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. A three character currency code such as USD. - currentPriceDetailsSorted
-
Type:
array
currentPriceDetailsSortedAdditional Properties Allowed:The current price details. - discountable
-
Type:
boolean
Whether discountable. - discounted
-
Type:
boolean
Whether the recurring charge price is discounted. - listPrice
-
Type:
number
The monetary amount of the list price. - onSale
-
Type:
boolean
Whether is on sale. - priceListId
-
Type:
string
The price list ID used for pricing. - quantityDiscounted
-
Type:
integer
The quantity discounted. - rawTotalPrice
-
Type:
number
The raw total price of the recurring charge. - salePrice
-
Type:
number
The sale price - shippingSurcharge
-
Type:
number
Extra handling cost for shipping the product.
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- actionCode
-
Type:
string
The action code that has been set on the externalData item by the configurator system. - name
-
Type:
string
Required:true
The name to be associated with the externalData item. - values
-
Type:
object
valuesRequired:true
Additional Properties Allowed:The array of values associated with an externalData item.
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
- dynamic_property_key
-
Type:
string
Required:true
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this price info. - secondaryCurrencyTaxAmount
-
Type:
number
The tax amount in secondary currency - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this price info.
- highBound
-
Type:
integer
The upper bound of the range this price info covers. - lowBound
-
Type:
integer
The lower bound of the range this price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : currentPriceDetailsSorted
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary amount for the recurring charge. - amountIsFinal
-
Type:
boolean
Whether the recurring charge amount is final. - currencyCode
-
Type:
string
The three character currency code for the monetary amounts. - detailedUnitPrice
-
Type:
number
The detailed unit price: amount / quantity. (read-only) - discounted
-
Type:
boolean
Whether the price is discounted. - quantity
-
Type:
integer
The number of items covered by this recurring charge price info - range
-
Type:
object
rangeAdditional Properties Allowed:Represents which specific items are covered by this recurring charge price info. - tax
-
Type:
number
Monetary tax amount.
Nested Schema : range
Type:
object
Represents which specific items are covered by this recurring charge price info.
- highBound
-
Type:
integer
The upper bound of the range this recurring charge price info covers. - lowBound
-
Type:
integer
The lower bound of the range this recurring charge price info covers, inclusive. - size
-
Type:
integer
The number of items in this range, inclusive. (read-only)
Nested Schema : items
Type:
object
- amount
-
Type:
number
Required:true
The monetary amount of the payment. - amountAuthorized
-
Type:
number
The monetary amount authorized. - authorizationStatus
-
Type:
array
authorizationStatusAdditional Properties Allowed:Aray of authorization status objects. - creditCardNumber
-
Type:
string
The last four digits of the credit card number. (only for TokenizedCreditCards) - creditCardType
-
Type:
string
The type of the credit card. (only for TokenizedCreditCards) - currencyCode
-
Type:
string
The three character currency code. For example: USD. - expirationDayOfMonth
-
Type:
string
A string containing the two digit day of month when the credit card expires. (only only for TokenizedCreditCards) - expirationMonth
-
Type:
string
A string containing the two digit month when the credit card expires. (only only for TokenizedCreditCards) - expirationYear
-
Type:
string
A string containing the two or four digit year when the credit card expires. (only only for TokenizedCreditCards) - externalId
-
Type:
string
The ID for the payment group in an external system (like the OMS) - externalSourceId
-
Type:
string
The external source ID, limited to 6 characters. (only for ExternalPaymentGroups) - externalSubtype
-
Type:
string
The subtype in the external system. Might be "VISA" for a PaymentGroup with an external type of "CreditCard". (only for ExternalPaymentGroups) - externalType
-
Type:
string
The type in the external system. Might be "StoreCredit", "CreditCard", "Check", etc. (only for ExternalPaymentGroups). - id
-
Type:
string
The internal ID of the payment group. - paymentGroupClassType
-
Type:
string
Required:true
The class type of the payment group. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup". - paymentMethod
-
Type:
string
Required:true
The payment method. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup". - PONumber
-
Type:
string
The purchase order number. - state
-
Type:
string
The state of this payment group. - stateDetail
-
Type:
string
Details about the state of this payment group. - submittedDate
-
Type:
string
The date the payment was submitted. - token
-
Type:
string
The CyberSource token string. (only for tokenizedCreditCard)
Nested Schema : shippingAddress
Type:
object
Default shipping address
- address1
-
Type:
string
Address Line 1. - address2
-
Type:
string
Address Line 2. - address3
-
Type:
string
Address Line 3. - city
-
Type:
string
City. - country
-
Type:
string
Country. - county
-
Type:
string
Name of the county. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Postal code. - state
-
Type:
string
State.
Nested Schema : frequencyAmountTotals
Nested Schema : frequencyTaxTotals
Nested Schema : items
Type:
object
- frequency
-
Type:
string
The frequency for the item's total e.g. Monthly. - total
-
Type:
string
The total amount for the frequency.
Nested Schema : items
Type:
object
- frequency
-
Type:
string
The frequency for the item's tax e.g. Monthly. - tax
-
Type:
string
The tax amount for the frequency.
Nested Schema : items
Type:
object
- actualShipDate
-
Type:
string
The actual shipped date of this shipping group. - commerceItemRelationships
-
Type:
array
commerceItemRelationshipsAdditional 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:
string
The description of this shipping group. Defaults to the ID. - handlingInstructions
-
Type:
array
handlingInstructionsAdditional Properties Allowed:Handling instructions. Currently read-only. - id
-
Type:
string
The ID of this shipping group. - priceInfo
-
Type:
object
priceInfoAdditional Properties Allowed:The pricing details about this shipping group. - shipOnDate
-
Type:
string
The date this shipping group is expected to ship upon. - shippingAddress
-
Type:
object
shippingAddressAdditional Properties Allowed:The shipping address for this shipping group. - shippingGroupClassType
-
Type:
string
The class type for the ShippingGroup. Currently must be "hardgoodShippingGroup". - shippingMethod
-
Type:
string
The shipping method. - specialInstructions
-
Type:
array
specialInstructionsAdditional Properties Allowed:Special instructions for the shipping group. Keys and values are strings. - state
-
Type:
string
The state of this shipping group. - stateDetail
-
Type:
string
Details about the state of this shipping group. - submittedDate
-
Type:
string
The date the shipping group was submitted. - trackingNumber
-
Type:
string
The 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:
array
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.
Nested Schema : handlingInstructions
Nested Schema : priceInfo
Type:
object
The pricing details about this shipping group.
- amount
-
Type:
number
The monetary amount. - amountIsFinal
-
Type:
boolean
Whether the amount is final. - currencyCode
-
Type:
string
The currency code for the monetary amounts. - discounted
-
Type:
boolean
Whether this item is discounted. - rawShipping
-
Type:
number
The monitary amount of the cost of raw shipping.
Nested Schema : shippingAddress
Type:
object
The shipping address for this shipping group.
- address1
-
Type:
string
Address Line 1. - address2
-
Type:
string
Address Line 2. - address3
-
Type:
string
Address Line 3. - city
-
Type:
string
City. - companyName
-
Type:
string
Company name. - country
-
Type:
string
Country. - county
-
Type:
string
Name of the county. -
Type:
string
The email address - faxNumber
-
Type:
string
The fax number. - firstName
-
Type:
string
First name. - id
-
Type:
string
ID. - jobTitle
-
Type:
string
Job title. - lastName
-
Type:
string
Last name. - middleName
-
Type:
string
Middle name. - ownerId
-
Type:
string
The ID of the owner of this address. - phoneNumber
-
Type:
string
Phone number. - postalCode
-
Type:
string
Postal code. - prefix
-
Type:
string
Prefix. - state
-
Type:
string
State. - suffix
-
Type:
string
Suffix.
Nested Schema : specialInstructions
Type:
array
Special instructions for the shipping group. Keys and values are strings.
-
Type:
string
Nested Schema : items
Type:
object
- amount
-
Type:
number
The monetary value. - commerceItemExternalId
-
Type:
string
The referenced commerce item's external ID. - commerceItemId
-
Type:
string
The referenced commerce item's internal ID. - id
-
Type:
string
The native ID of this item. - quantity
-
Type:
integer
The quantity of items referenced by this relationship. - relationshipType
-
Type:
string
The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING. - returnedQuantity
-
Type:
integer
Number 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:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - errors
-
Type:
array
errorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code - type
-
Type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object
- devMessage
-
Type:
string
An optional non-localized message containing technical information for developers - errorCode
-
Type:
string
The numerical code identifying the error - message
-
Type:
string
The localized message describing the error - moreInfo
-
Type:
string
An optional non-localized message with more information - o:errorPath
-
Type:
string
An optional machine readable description of where the error occurred - status
-
Type:
string
The HTTP status code
Examples
Sample Request:
{ "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" }