- REST API for Oracle Commerce Cloud
- Tasks
- Store
- Store Extension
- Admin
- Orders
get
/ccapp/v1/orders
Get Orders. This operation is used to get a collection of orders from Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Query Parameters
-
fields: string
This controls which fields are returned in the response body. The default is to include the top-level response fields and the Audience id, displayName, description, and enabled fields.
-
limit: integer
This is the field to specify the number of records to be fetched per REST call.
-
offset: integer
This field specifies the offset/starting index from which data to be fetched.
-
q: string
This field specifies the query used to limit the orders returns. Defaults to RQL. To use SCIM use the queryFormat parameter
-
queryFormat: string
Specifies the format of the query. For backwards compatibility, the default query format is RQL. Specify a value of "SCIM" to use SCIM query format.
-
sort: string
This field specifies the sort order of the list to be fetched.
-
totalResults: boolean
Indicates if the total results should be included in the response.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body ()
Root Schema : getOrders_response
Type:
Show Source
object-
items:
array items
Array containing the object representations of orders. See updateOrder for a description of the values of each order.
-
limit:
integer
Limit of number of products.
-
offset:
integer
Numeric offset of the first order item returned.
-
sort:
array sort
An array that specifies the sort order.
-
total:
integer
Total number of products. Deprecated.
-
totalResults:
integer
Total number of products.
{
"properties":{
"total":{
"description":"Total number of products. Deprecated.",
"type":"integer"
},
"totalResults":{
"description":"Total number of products.",
"type":"integer"
},
"offset":{
"description":"Numeric offset of the first order item returned.",
"type":"integer"
},
"limit":{
"description":"Limit of number of products.",
"type":"integer"
},
"sort":{
"description":"An array that specifies the sort order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The name of the property to use for sorting.",
"type":"string"
},
"order":{
"description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
"type":"string"
}
}
}
},
"items":{
"description":"Array containing the object representations of orders. See updateOrder for a description of the values of each order.",
"type":"array",
"items":{
"$ref":"#/definitions/updateOrder_request"
}
}
}
}Nested Schema : items
Type:
arrayArray containing the object representations of orders. See updateOrder for a description of the values of each order.
Show Source
{
"description":"Array containing the object representations of orders. See updateOrder for a description of the values of each order.",
"type":"array",
"items":{
"$ref":"#/definitions/updateOrder_request"
}
}Nested Schema : sort
Type:
arrayAn array that specifies the sort order.
Show Source
{
"description":"An array that specifies the sort order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"property":{
"description":"The name of the property to use for sorting.",
"type":"string"
},
"order":{
"description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
"type":"string"
}
}
}
}Nested Schema : updateOrder_request
Type:
Show Source
object-
additionalEmails:
array additionalEmails
Additional emails to send order confirmation. Default limit is 10.
-
agentId:
string
profile id of the agent associated with the order.
-
cancelReason:
string
Reason through which the order has been cancelled.
-
commerceItems:
array commerceItems
The commerce items (sometimes referred to as "line items") represent which actual skus are included in the 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.
-
creationSiteId:
string
The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime:
integer
The creation time.
-
discountInfo:
object discountInfo
Discount information.
-
exchangeRate:
number
The coversion rate used to convert values from primary currency to secondary currency. Primary currency refers to to currency code associated with the order level price list group.
-
id:
string
The ID
-
lastModifiedTime:
integer
The last modified time.
-
locale:
string
The locale in which order submitted.
-
markers:
array markers
Order markers information (read-only)
-
orderAction:
string
The action performed on the order.
-
organizationId:
string
The organization ID.
-
paymentGroupCount:
integer
The number of payment groups. (read-only, value is ignored when updating)
-
paymentGroups:
array paymentGroups
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:
string
The ID of the price group to which the order belongs.
-
priceInfo:
object priceInfo
Pricing information, an instance of OrderPriceInfo.
-
profile:
object profile
Basic profile information. (read-only)
-
profileId:
string
The ID of the shopper profile that owns the order.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information of the order
-
salesChannel:
string
The sales channel of this order. default to "default".
-
secondaryCurrencyCode:
string
The currency code of secondary currency associated with the site.
-
shippingGroupCount:
integer
The number of shipping groups (read-only, value is ignored when updating).
-
shippingGroups:
array shippingGroups
-
siteId:
string
The ID of the site on which the order was placed.
-
soldTo:
object soldTo
soldTo details for B2B orders only
-
sourceSystem:
string
The system where the order originated.
-
state:
string
The state of the order.
-
submissionInfo:
object submissionInfo
Details of post submission references.
-
taxExempt:
boolean
Whether order is tax-exempt or not.
-
taxPriceInfo:
object taxPriceInfo
The tax pricing details for the order.
-
totalCommerceItemCount:
integer
The total count of commerce items in the order. (read-only)
{
"properties":{
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"type":"string"
},
"agentId":{
"description":"profile id of the agent associated with the order.",
"type":"string"
},
"lastModifiedTime":{
"description":"The last modified time.",
"type":"integer"
},
"priceGroupId":{
"description":"The ID of the price group to which the order belongs.",
"type":"string"
},
"creationTime":{
"description":"The creation time.",
"type":"integer"
},
"sourceSystem":{
"description":"The system where the order originated.",
"type":"string"
},
"paymentGroups":{
"description":"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.",
"type":"array",
"items":{
"type":"object",
"properties":{
"expirationYear":{
"description":"A string containing the two or four digit year when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"PONumber":{
"description":"The purchase order number.",
"type":"string"
},
"amountAuthorized":{
"description":"The monetary amount authorized.",
"type":"number"
},
"externalType":{
"description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
"type":"string"
},
"amount":{
"description":"The monetary amount of the payment.",
"type":"number"
},
"externalId":{
"description":"The ID for the payment group in an external system (like the OMS)",
"type":"string"
},
"creditCardType":{
"description":"The type of the credit card. (only for TokenizedCreditCards)",
"type":"string"
},
"expirationMonth":{
"description":"A string containing the two digit month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"submittedDate":{
"description":"The date the payment was submitted.",
"type":"string"
},
"authorizationStatus":{
"description":"Array of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
},
"token":{
"description":"The CyberSource token string. (only for tokenizedCreditCard)",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of the credit card.",
"type":"string"
},
"paymentGroupClassType":{
"description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"creditCardNumber":{
"description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
"type":"string"
},
"billTo":{
"description":"billTo details for invoice payment. Applicable for B2B orders only",
"type":"object",
"properties":{
"siteUseId":{
"description":"site use id",
"type":"string"
},
"customerAccountId":{
"description":"customer account id, (It corresponds to the billTo-address accountId property)",
"type":"string"
},
"partyId":{
"description":"party id ",
"type":"string"
}
}
},
"externalSubtype":{
"description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
"type":"string"
},
"paymentMethod":{
"description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"externalSourceId":{
"description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
"type":"string"
},
"billingAddress":{
"description":"List of billing addresses associated with profile.",
"type":"array",
"items":{
"$ref":"#/definitions/order_billingAddress"
}
},
"id":{
"description":"The internal ID of the payment group.",
"type":"string"
},
"state":{
"description":"The state of this payment group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this payment group.",
"type":"string"
},
"currencyCode":{
"description":"The three character currency code. For example: USD.",
"type":"string"
},
"expirationDayOfMonth":{
"description":"A string containing the two digit day of month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
}
},
"required":[
"amount",
"paymentGroupClassType",
"paymentMethod"
]
}
},
"salesChannel":{
"description":"The sales channel of this order. default to \"default\".",
"type":"string"
},
"locale":{
"description":"The locale in which order submitted.",
"type":"string"
},
"organizationId":{
"description":"The organization ID.",
"type":"string"
},
"priceInfo":{
"description":"Pricing information, an instance of OrderPriceInfo.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \\nPrerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.",
"type":"number"
},
"manualAdjustmentTotal":{
"description":"The monetary total of manual adjustments.",
"type":"number"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"rawSubtotal":{
"description":"The monetary raw subtotal.",
"type":"number"
},
"total":{
"description":"The monetary total: amount + shipping + tax. (read-only)",
"type":"number"
},
"shipping":{
"description":"The monetary cost of shipping.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":" An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"orderTotalBySite":{
"description":"The map containing order totals by site for all sites in a given order.",
"type":"object"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"exchangeRate":{
"description":"The coversion rate used to convert values from primary currency to secondary currency. Primary currency refers to to currency code associated with the order level price list group.",
"type":"number"
},
"additionalEmails":{
"description":"Additional emails to send order confirmation. Default limit is 10.",
"type":"array",
"items":{
"type":"string"
}
},
"totalCommerceItemCount":{
"description":"The total count of commerce items in the order. (read-only)",
"type":"integer"
},
"id":{
"description":"The ID",
"type":"string"
},
"state":{
"description":"The state of the order.",
"type":"string"
},
"cancelReason":{
"description":"Reason through which the order has been cancelled.",
"type":"string"
},
"commerceItems":{
"description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in the 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.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"gwp":{
"description":"Flag to indicate whether the item exists as a result of a gift with purchase promotion.",
"type":"boolean"
},
"returnedQuantity":{
"description":"The quantity returned.",
"type":"integer"
},
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity.",
"type":"integer"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included.",
"type":"integer"
},
"configuratorId":{
"description":"Configuration id for the configurable commerce item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"itemDiscountInfos":{
"description":"Array of item promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"secondaryShippingSurcharge":{
"description":"Extra handling cost in secondary currency for shipping the product.",
"type":"number"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogId":{
"description":"The ID of the catalog which this commerce item references.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"External quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price for this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"The internal/native ID for this commerce item.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this commerce item.",
"type":"string"
},
"locationInventoryInfoMap":{
"description":"This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id",
"additionalProperties":{
"type":"object",
"properties":{
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity, for this inventory location",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included, for this inventory location",
"type":"integer"
},
"backOrderQuantity":{
"description":"The backordered quantity included, for this inventory location",
"type":"integer"
},
"inStockQuantity":{
"description":"The available quantity included that is 'in stock', for this inventory location",
"type":"integer"
}
}
},
"type":"object"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalId":{
"description":"An optional, external ID for this commerce item.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"originalCommerceItemId":{
"description":"The Commerce Item ID associated with the original item from which item in cancel order is created.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"charges":{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogKey":{
"description":"The key of the catalog this commerce item references.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name. (read-only, obtained from the referenced product)",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"backOrderQuantity":{
"description":"The backordered quantity included.",
"type":"integer"
}
}
}
},
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"discounted":{
"description":"Whether the price was discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"districtTax":{
"description":"Tax amount for the district.",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"countryTax":{
"description":"The monetary amount of country tax.",
"type":"number"
}
}
},
"shippingGroups":{
"type":"array",
"items":{
"$ref":"#/definitions/updateOrderRequestShippingGroups"
}
},
"soldTo":{
"description":"soldTo details for B2B orders only",
"type":"object",
"properties":{
"partyId":{
"description":"party id",
"type":"string"
},
"partyNumber":{
"description":"party number",
"type":"string"
}
}
},
"taxExempt":{
"description":"Whether order is tax-exempt or not.",
"type":"boolean"
},
"creationSiteId":{
"description":"The ID of the site on which the order was created. This may differ to siteId value if the site is part of a cart sharing group.",
"type":"string"
},
"profile":{
"description":"Basic profile information. (read-only)",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"country":{
"description":"Country.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"partyId":{
"description":"Party Id of the contact",
"type":"number"
},
"partyNumber":{
"description":"Party Number of the contact",
"type":"string"
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"submissionInfo":{
"description":"Details of post submission references.",
"type":"object",
"properties":{
"externalId":{
"description":"id of submitted order in external system",
"type":"string"
},
"errorInfo":{
"description":"Error Details",
"type":"string"
},
"source":{
"description":"Source",
"type":"string"
}
}
},
"shippingGroupCount":{
"description":"The number of shipping groups (read-only, value is ignored when updating).",
"type":"integer"
},
"orderAction":{
"description":"The action performed on the order.",
"type":"string"
},
"paymentGroupCount":{
"description":"The number of payment groups. (read-only, value is ignored when updating)",
"type":"integer"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information of the order",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"total":{
"description":"The monetary total: amount + shipping + tax. (read-only)",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"The monetary cost of shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"manualAdjustmentTotal":{
"description":"The monetary total of manual adjustments.",
"type":"number"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"rawSubtotal":{
"description":"The monetary raw subtotal.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"description":"The coupons that were not claimed",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
},
"claimedCouponMultiPromotions":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}
}
},
"profileId":{
"description":"The ID of the shopper profile that owns the order.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"markers":{
"description":"Order markers information (read-only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. In the case of a marketing campaign, it represents the actual unique campaign ID",
"type":"string"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua\"",
"type":"string"
}
}
}
}
},
"example":{
"priceGroupId":"defaultPriceGroup",
"lastModifiedTime":"1409947606000",
"creationTime":"1409947604000",
"sourceSystem":"Cloud Commerce",
"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",
"billTo":{
"siteUseId":"5282",
"customerAccountId":"4564",
"partyId":"2222"
},
"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@example.com"
},
"id":"pg10076",
"currencyCode":"USD"
}
],
"organizationId":"100001",
"relationships":[
{
"paymentGroupId":"pg10076",
"amount":96.27,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r10068"
}
],
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":1.5,
"amount":89.97,
"secondaryCurrencyShippingAmount":6,
"secondaryCurrencyTotal":7.5,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":6.3,
"rawSubtotal":89.97,
"total":96.27,
"shipping":0,
"primaryCurrencyTotal":89.97,
"amountIsFinal":false,
"orderTotalBySite":{
"siteUS":96.27
},
"currencyCode":"USD"
},
"additionalEmails":[
"w.rubble@bedrock.com",
"w.flintstone@bedrock.com"
],
"totalCommerceItemCount":3,
"state":"SUBMITTED",
"id":"o10076",
"cancelReason":"badProductReview",
"commerceItems":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"preOrderQuantity":1,
"configuratorId":"123455",
"assetKey":"12345",
"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,
"assetId":"asset10001",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"externalPriceDetails":{
"externalPriceQuantity":1,
"externalPrice":100
},
"actionCode":"Add",
"id":"ci1000076",
"serviceId":"service-123",
"locationInventoryInfoMap":{
"__NULL__":{
"availabilityDate":null,
"preOrderQuantity":0,
"backOrderQuantity":1,
"inStockQuantity":0
},
"Boston128":{
"availabilityDate":null,
"preOrderQuantity":1,
"backOrderQuantity":0,
"inStockQuantity":1
}
},
"commerceItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"addOnItem":false,
"quantity":1,
"productId":"prod40001",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku40001",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"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
},
"assetId":"asset10001",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
},
{
"serviceAccountId":"serviceAcc-123",
"configurationOptionId":"sku2442",
"deactivationDate":"2018-06-27T12:59:59Z",
"addOnItem":true,
"quantity":1,
"productId":"prod40002",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"configurablePropertyId":"product10222",
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku40005",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"actionCode":"Add",
"shopperInput":{
"message":"Best Wishes my friend",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"serviceAccountId":"serviceAcc-123",
"quantity":3,
"productId":"prod10021",
"externalId":null,
"parentAssetKey":null,
"originalCommerceItemId":null,
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku10017",
"customerAccountId":"customerAcc-123",
"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",
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"backOrderQuantity":1
}
],
"taxPriceInfo":{
"discounted":false,
"cityTax":0,
"secondaryCurrencyTaxAmount":1.5,
"amount":6.3,
"countyTax":0.9,
"amountIsFinal":false,
"districtTax":0,
"stateTax":5.4,
"currencyCode":"USD",
"countryTax":0
},
"shippingGroups":[
{
"lastName":"Black",
"shippingMethod":"freeShippingMethod",
"description":"sg10076",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":1.5,
"amount":0,
"secondaryCurrencyShippingAmount":6,
"rawShipping":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"firstName":"Joe",
"phoneNumber":"123456789",
"shipOnDate":null,
"actualShipDate":null,
"trackingInfo":[
{
"carrierName":"USPS",
"trackingUrl":"https://tools.example.com/go/TrackConfirmAction_input?qtc_tLabels1=ABC123",
"carrierId":"USPS",
"trackingNumber":"ABC123"
}
],
"specialInstructions":{
},
"locationId":"SiteUS-GlenAllen187",
"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":"9085554321",
"faxNumber":null,
"middleName":null,
"state":"FL",
"id":"sg10076",
"email":"FLORENCE.FLORES@example.com"
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-07-23T12:12:58.000Z",
"commerceItemId":"ci1000076",
"inventoryLocationId":null,
"amount":0,
"quantity":3,
"relationshipType":"SHIPPINGQUANTITY",
"pointOfNoRevision":true,
"returnedQuantity":0,
"preferredPickupDate":"2018-07-23T12:12:58.000Z",
"commerceItemExternalId":null,
"id":"r10066"
}
],
"state":"INITIAL",
"id":"sg10076",
"stateDetail":null,
"trackingNumber":"USPS-ABC123",
"email":"a.a@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"soldTo":{
"partyId":"2222",
"partyNumber":"222"
},
"taxExempt":false,
"creationSiteId":"siteUS",
"profile":{
"lastName":"FLORES",
"firstName":"FLORENCE",
"customerContactId":"CRMID_1",
"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@example.com"
},
"shippingGroupCount":1,
"orderAction":"order",
"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"
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
{
"promotionLongDesc":"<p>Buy 1 get 10</p>",
"promotionName":"Buy 1 get 10",
"promotion_campaign":"test_campaign",
"promotionLevel":"order",
"totalAdjustment":"-1.0",
"promotionDesc":"Buy 1 get 10",
"promotionId":"promo10001"
}
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"profileId":"se-570031",
"siteId":"siteUS",
"markers":[
{
"value":"78900",
"key":"campaign_eloqua"
}
]
}
}Example:
{
"priceGroupId":"defaultPriceGroup",
"lastModifiedTime":"1409947606000",
"creationTime":"1409947604000",
"sourceSystem":"Cloud Commerce",
"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",
"billTo":{
"siteUseId":"5282",
"customerAccountId":"4564",
"partyId":"2222"
},
"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@example.com"
},
"id":"pg10076",
"currencyCode":"USD"
}
],
"organizationId":"100001",
"relationships":[
{
"paymentGroupId":"pg10076",
"amount":96.27,
"relationshipType":"ORDERAMOUNTREMAINING",
"id":"r10068"
}
],
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":1.5,
"amount":89.97,
"secondaryCurrencyShippingAmount":6,
"secondaryCurrencyTotal":7.5,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":6.3,
"rawSubtotal":89.97,
"total":96.27,
"shipping":0,
"primaryCurrencyTotal":89.97,
"amountIsFinal":false,
"orderTotalBySite":{
"siteUS":96.27
},
"currencyCode":"USD"
},
"additionalEmails":[
"w.rubble@bedrock.com",
"w.flintstone@bedrock.com"
],
"totalCommerceItemCount":3,
"state":"SUBMITTED",
"id":"o10076",
"cancelReason":"badProductReview",
"commerceItems":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"preOrderQuantity":1,
"configuratorId":"123455",
"assetKey":"12345",
"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,
"assetId":"asset10001",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"externalPriceDetails":{
"externalPriceQuantity":1,
"externalPrice":100
},
"actionCode":"Add",
"id":"ci1000076",
"serviceId":"service-123",
"locationInventoryInfoMap":{
"__NULL__":{
"availabilityDate":null,
"preOrderQuantity":0,
"backOrderQuantity":1,
"inStockQuantity":0
},
"Boston128":{
"availabilityDate":null,
"preOrderQuantity":1,
"backOrderQuantity":0,
"inStockQuantity":1
}
},
"commerceItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"addOnItem":false,
"quantity":1,
"productId":"prod40001",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku40001",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"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
},
"assetId":"asset10001",
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
},
{
"serviceAccountId":"serviceAcc-123",
"configurationOptionId":"sku2442",
"deactivationDate":"2018-06-27T12:59:59Z",
"addOnItem":true,
"quantity":1,
"productId":"prod40002",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"configurablePropertyId":"product10222",
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku40005",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"assetId":"asset10001",
"actionCode":"Add",
"shopperInput":{
"message":"Best Wishes my friend",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
],
"serviceAccountId":"serviceAcc-123",
"quantity":3,
"productId":"prod10021",
"externalId":null,
"parentAssetKey":null,
"originalCommerceItemId":null,
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catalogRefId":"sku10017",
"customerAccountId":"customerAcc-123",
"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",
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"backOrderQuantity":1
}
],
"taxPriceInfo":{
"discounted":false,
"cityTax":0,
"secondaryCurrencyTaxAmount":1.5,
"amount":6.3,
"countyTax":0.9,
"amountIsFinal":false,
"districtTax":0,
"stateTax":5.4,
"currencyCode":"USD",
"countryTax":0
},
"shippingGroups":[
{
"lastName":"Black",
"shippingMethod":"freeShippingMethod",
"description":"sg10076",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":1.5,
"amount":0,
"secondaryCurrencyShippingAmount":6,
"rawShipping":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"firstName":"Joe",
"phoneNumber":"123456789",
"shipOnDate":null,
"actualShipDate":null,
"trackingInfo":[
{
"carrierName":"USPS",
"trackingUrl":"https://tools.example.com/go/TrackConfirmAction_input?qtc_tLabels1=ABC123",
"carrierId":"USPS",
"trackingNumber":"ABC123"
}
],
"specialInstructions":{
},
"locationId":"SiteUS-GlenAllen187",
"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":"9085554321",
"faxNumber":null,
"middleName":null,
"state":"FL",
"id":"sg10076",
"email":"FLORENCE.FLORES@example.com"
},
"commerceItemRelationships":[
{
"availablePickupDate":"2018-07-23T12:12:58.000Z",
"commerceItemId":"ci1000076",
"inventoryLocationId":null,
"amount":0,
"quantity":3,
"relationshipType":"SHIPPINGQUANTITY",
"pointOfNoRevision":true,
"returnedQuantity":0,
"preferredPickupDate":"2018-07-23T12:12:58.000Z",
"commerceItemExternalId":null,
"id":"r10066"
}
],
"state":"INITIAL",
"id":"sg10076",
"stateDetail":null,
"trackingNumber":"USPS-ABC123",
"email":"a.a@example.com",
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"soldTo":{
"partyId":"2222",
"partyNumber":"222"
},
"taxExempt":false,
"creationSiteId":"siteUS",
"profile":{
"lastName":"FLORES",
"firstName":"FLORENCE",
"customerContactId":"CRMID_1",
"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@example.com"
},
"shippingGroupCount":1,
"orderAction":"order",
"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"
},
"discountInfo":{
"unclaimedCouponMultiPromotions":{
},
"orderCouponsMap":{
},
"orderDiscount":0,
"shippingDiscount":0,
"orderImplicitDiscountList":[
{
"promotionLongDesc":"<p>Buy 1 get 10</p>",
"promotionName":"Buy 1 get 10",
"promotion_campaign":"test_campaign",
"promotionLevel":"order",
"totalAdjustment":"-1.0",
"promotionDesc":"Buy 1 get 10",
"promotionId":"promo10001"
}
],
"unclaimedCouponsMap":{
},
"claimedCouponMultiPromotions":{
}
},
"profileId":"se-570031",
"siteId":"siteUS",
"markers":[
{
"value":"78900",
"key":"campaign_eloqua"
}
]
}Nested Schema : additionalEmails
Type:
arrayAdditional emails to send order confirmation. Default limit is 10.
Show Source
{
"description":"Additional emails to send order confirmation. Default limit is 10.",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : commerceItems
Type:
arrayThe commerce items (sometimes referred to as "line items") represent which actual skus are included in the 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.
Show Source
{
"description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in the 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.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"gwp":{
"description":"Flag to indicate whether the item exists as a result of a gift with purchase promotion.",
"type":"boolean"
},
"returnedQuantity":{
"description":"The quantity returned.",
"type":"integer"
},
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity.",
"type":"integer"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included.",
"type":"integer"
},
"configuratorId":{
"description":"Configuration id for the configurable commerce item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"itemDiscountInfos":{
"description":"Array of item promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"secondaryShippingSurcharge":{
"description":"Extra handling cost in secondary currency for shipping the product.",
"type":"number"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogId":{
"description":"The ID of the catalog which this commerce item references.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"External quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price for this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"The internal/native ID for this commerce item.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this commerce item.",
"type":"string"
},
"locationInventoryInfoMap":{
"description":"This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id",
"additionalProperties":{
"type":"object",
"properties":{
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity, for this inventory location",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included, for this inventory location",
"type":"integer"
},
"backOrderQuantity":{
"description":"The backordered quantity included, for this inventory location",
"type":"integer"
},
"inStockQuantity":{
"description":"The available quantity included that is 'in stock', for this inventory location",
"type":"integer"
}
}
},
"type":"object"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalId":{
"description":"An optional, external ID for this commerce item.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"originalCommerceItemId":{
"description":"The Commerce Item ID associated with the original item from which item in cancel order is created.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"charges":{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogKey":{
"description":"The key of the catalog this commerce item references.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name. (read-only, obtained from the referenced product)",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"backOrderQuantity":{
"description":"The backordered quantity included.",
"type":"integer"
}
}
}
}Nested Schema : discountInfo
Type:
objectDiscount information.
Show Source
-
claimedCouponMultiPromotions:
object claimedCouponMultiPromotions
The coupons that were claimed.
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
shippingDiscount:
number
The shipping discount.
-
unclaimedCouponMultiPromotions:
object unclaimedCouponMultiPromotions
The coupons that were not claimed
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
{
"description":"Discount information.",
"type":"object",
"properties":{
"unclaimedCouponMultiPromotions":{
"description":"The coupons that were not claimed",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
},
"orderCouponsMap":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
},
"orderDiscount":{
"description":"Discount given on an order.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
},
"orderImplicitDiscountList":{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"unclaimedCouponsMap":{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
},
"claimedCouponMultiPromotions":{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}
}
}Nested Schema : markers
Type:
arrayOrder markers information (read-only)
Show Source
{
"description":"Order markers information (read-only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. In the case of a marketing campaign, it represents the actual unique campaign ID",
"type":"string"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua\"",
"type":"string"
}
}
}
}Nested Schema : paymentGroups
Type:
arrayThe array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
Show Source
{
"description":"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.",
"type":"array",
"items":{
"type":"object",
"properties":{
"expirationYear":{
"description":"A string containing the two or four digit year when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"PONumber":{
"description":"The purchase order number.",
"type":"string"
},
"amountAuthorized":{
"description":"The monetary amount authorized.",
"type":"number"
},
"externalType":{
"description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
"type":"string"
},
"amount":{
"description":"The monetary amount of the payment.",
"type":"number"
},
"externalId":{
"description":"The ID for the payment group in an external system (like the OMS)",
"type":"string"
},
"creditCardType":{
"description":"The type of the credit card. (only for TokenizedCreditCards)",
"type":"string"
},
"expirationMonth":{
"description":"A string containing the two digit month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"submittedDate":{
"description":"The date the payment was submitted.",
"type":"string"
},
"authorizationStatus":{
"description":"Array of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
},
"token":{
"description":"The CyberSource token string. (only for tokenizedCreditCard)",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of the credit card.",
"type":"string"
},
"paymentGroupClassType":{
"description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"creditCardNumber":{
"description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
"type":"string"
},
"billTo":{
"description":"billTo details for invoice payment. Applicable for B2B orders only",
"type":"object",
"properties":{
"siteUseId":{
"description":"site use id",
"type":"string"
},
"customerAccountId":{
"description":"customer account id, (It corresponds to the billTo-address accountId property)",
"type":"string"
},
"partyId":{
"description":"party id ",
"type":"string"
}
}
},
"externalSubtype":{
"description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
"type":"string"
},
"paymentMethod":{
"description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"externalSourceId":{
"description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
"type":"string"
},
"billingAddress":{
"description":"List of billing addresses associated with profile.",
"type":"array",
"items":{
"$ref":"#/definitions/order_billingAddress"
}
},
"id":{
"description":"The internal ID of the payment group.",
"type":"string"
},
"state":{
"description":"The state of this payment group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this payment group.",
"type":"string"
},
"currencyCode":{
"description":"The three character currency code. For example: USD.",
"type":"string"
},
"expirationDayOfMonth":{
"description":"A string containing the two digit day of month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
}
},
"required":[
"amount",
"paymentGroupClassType",
"paymentMethod"
]
}
}Nested Schema : priceInfo
Type:
objectPricing information, an instance of OrderPriceInfo.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
discountAmount:
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
manualAdjustmentTotal:
number
The monetary total of manual adjustments.
-
orderTotalBySite:
object orderTotalBySite
The map containing order totals by site for all sites in a given order.
-
primaryCurrencyTotal:
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.\nPrerequisites for the value in this Attribute:\n1. PriceList configured for the site is in custom currency.\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
-
rawSubtotal:
number
The monetary raw subtotal.
-
secondaryCurrencyShippingAmount:
number
This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.\nPrerequisites for the value in this Attribute:\n1. PriceList configured for the site is in custom currency.\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
-
secondaryCurrencyTaxAmount:
number
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \nPrerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:\n1. PriceList configured for the site is in custom currency.\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
-
secondaryCurrencyTotal:
number
An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.\nPrerequisites for the value in this Attribute:\n1. PriceList configured for the site is in custom currency.\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
-
shipping:
number
The monetary cost of shipping.
-
tax:
number
Monetary tax amount.
-
total:
number
The monetary total: amount + shipping + tax. (read-only)
{
"description":"Pricing information, an instance of OrderPriceInfo.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \\nPrerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.",
"type":"number"
},
"manualAdjustmentTotal":{
"description":"The monetary total of manual adjustments.",
"type":"number"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"rawSubtotal":{
"description":"The monetary raw subtotal.",
"type":"number"
},
"total":{
"description":"The monetary total: amount + shipping + tax. (read-only)",
"type":"number"
},
"shipping":{
"description":"The monetary cost of shipping.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":" An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"orderTotalBySite":{
"description":"The map containing order totals by site for all sites in a given order.",
"type":"object"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : profile
Type:
objectBasic profile information. (read-only)
Show Source
-
email:
string
The email address
-
firstName:
string
First name.
-
lastName:
string
Last name.
-
loyaltyPrograms:
array loyaltyPrograms
Loyalty Programs Information
-
middleName:
string
Middle name.
-
partyId:
number
Party Id of the contact
-
partyNumber:
string
Party Number of the contact
-
shippingAddress:
object shippingAddress
Default shipping address
{
"description":"Basic profile information. (read-only)",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"loyaltyPrograms":{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"Default shipping address",
"type":"object",
"properties":{
"country":{
"description":"Country.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"partyId":{
"description":"Party Id of the contact",
"type":"number"
},
"partyNumber":{
"description":"Party Number of the contact",
"type":"string"
},
"email":{
"description":"The email address",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information of the order
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
discountAmount:
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
frequencyAmountTotals:
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals:
array frequencyTaxTotals
The tax for each recurring charge frequency
-
manualAdjustmentTotal:
number
The monetary total of manual adjustments.
-
rawSubtotal:
number
The monetary raw subtotal.
-
shipping:
number
The monetary cost of shipping.
-
tax:
number
Monetary tax amount.
-
total:
number
The monetary total: amount + shipping + tax. (read-only)
{
"description":"Recurring charge price information of the order",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"total":{
"description":"The monetary total: amount + shipping + tax. (read-only)",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"The monetary cost of shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"manualAdjustmentTotal":{
"description":"The monetary total of manual adjustments.",
"type":"number"
},
"discountAmount":{
"description":"The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"rawSubtotal":{
"description":"The monetary raw subtotal.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : shippingGroups
Type:
Show Source
array{
"type":"array",
"items":{
"$ref":"#/definitions/updateOrderRequestShippingGroups"
}
}Nested Schema : soldTo
Type:
objectsoldTo details for B2B orders only
Show Source
-
partyId:
string
party id
-
partyNumber:
string
party number
{
"description":"soldTo details for B2B orders only",
"type":"object",
"properties":{
"partyId":{
"description":"party id",
"type":"string"
},
"partyNumber":{
"description":"party number",
"type":"string"
}
}
}Nested Schema : submissionInfo
Type:
objectDetails of post submission references.
Show Source
-
errorInfo:
string
Error Details
-
externalId:
string
id of submitted order in external system
-
source:
string
Source
{
"description":"Details of post submission references.",
"type":"object",
"properties":{
"externalId":{
"description":"id of submitted order in external system",
"type":"string"
},
"errorInfo":{
"description":"Error Details",
"type":"string"
},
"source":{
"description":"Source",
"type":"string"
}
}
}Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
cityTax:
number
The monetary amount of city tax.
-
countryTax:
number
The monetary amount of country tax.
-
countyTax:
number
The monetary amount of county tax.
-
currencyCode:
string
The three character currency code.
-
discounted:
boolean
Whether the price was discounted.
-
districtTax:
number
Tax amount for the district.
-
secondaryCurrencyTaxAmount:
number
The tax amount in secondary currency
-
stateTax:
number
Tax amount for the state.
{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"discounted":{
"description":"Whether the price was discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"districtTax":{
"description":"Tax amount for the district.",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"countryTax":{
"description":"The monetary amount of country tax.",
"type":"number"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate:
integer
The availabilityDate for preordered/backordered quantity.
-
backOrderQuantity:
integer
The backordered quantity included.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogId:
string
The ID of the catalog which this commerce item references.
-
catalogKey:
string
The key of the catalog this commerce item references.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
charges:
array charges
Charges applied on this commerce item if any.
-
commerceItems:
array commerceItems
-
configuratorId:
string
Configuration id for the configurable commerce item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalId:
string
An optional, external ID for this commerce item.
-
externalPriceDetails:
object externalPriceDetails
Details about pricing.
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
gwp:
boolean
Flag to indicate whether the item exists as a result of a gift with purchase promotion.
-
id:
string
The internal/native ID for this commerce item.
-
locationInventoryInfoMap:
object locationInventoryInfoMap
Additional Properties Allowed: additionalPropertiesThis is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
-
originalCommerceItemId:
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
pointOfNoRevision:
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
preOrderQuantity:
integer
The preordered quantity included.
-
priceInfo:
object priceInfo
Details about pricing.
-
productDisplayName:
string
The product's display name. (read-only, obtained from the referenced product)
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
returnedQuantity:
integer
The quantity returned.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
state:
string
The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
-
stateDetail:
string
Details about the state of this commerce item.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"gwp":{
"description":"Flag to indicate whether the item exists as a result of a gift with purchase promotion.",
"type":"boolean"
},
"returnedQuantity":{
"description":"The quantity returned.",
"type":"integer"
},
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity.",
"type":"integer"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included.",
"type":"integer"
},
"configuratorId":{
"description":"Configuration id for the configurable commerce item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"itemDiscountInfos":{
"description":"Array of item promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"secondaryShippingSurcharge":{
"description":"Extra handling cost in secondary currency for shipping the product.",
"type":"number"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogId":{
"description":"The ID of the catalog which this commerce item references.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"External quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price for this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"The internal/native ID for this commerce item.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this commerce item.",
"type":"string"
},
"locationInventoryInfoMap":{
"description":"This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id",
"additionalProperties":{
"type":"object",
"properties":{
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity, for this inventory location",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included, for this inventory location",
"type":"integer"
},
"backOrderQuantity":{
"description":"The backordered quantity included, for this inventory location",
"type":"integer"
},
"inStockQuantity":{
"description":"The available quantity included that is 'in stock', for this inventory location",
"type":"integer"
}
}
},
"type":"object"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalId":{
"description":"An optional, external ID for this commerce item.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"originalCommerceItemId":{
"description":"The Commerce Item ID associated with the original item from which item in cancel order is created.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"charges":{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"catalogKey":{
"description":"The key of the catalog this commerce item references.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name. (read-only, obtained from the referenced product)",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"backOrderQuantity":{
"description":"The backordered quantity included.",
"type":"integer"
}
}
}Nested Schema : charges
Type:
arrayCharges applied on this commerce item if any.
Show Source
{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about pricing.
Show Source
-
externalPrice:
number
External price for this commerce item
-
externalPriceQuantity:
integer
External quantity of this commerce item
{
"description":"Details about pricing.",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"External quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price for this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : locationInventoryInfoMap
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id",
"additionalProperties":{
"type":"object",
"properties":{
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity, for this inventory location",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included, for this inventory location",
"type":"integer"
},
"backOrderQuantity":{
"description":"The backordered quantity included, for this inventory location",
"type":"integer"
},
"inStockQuantity":{
"description":"The available quantity included that is 'in stock', for this inventory location",
"type":"integer"
}
}
},
"type":"object"
}This is a map displaying inventory breakdowns for multiple inventory locations, created when the item is fulfilled by multiple inventories. Each entry in the map is keyed by inventory location id
Nested Schema : priceInfo
Type:
objectDetails about pricing.
Show Source
-
amount:
number
The monetary amount of this order.
-
amountIsFinal:
boolean
Whether the amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the price is discounted.
-
itemDiscountInfos:
array itemDiscountInfos
Array of item promotions affecting this item (read-only).
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
orderDiscountInfos:
array orderDiscountInfos
Array of order promotions affecting this item (read-only).
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price.
-
salePrice:
number
The sale price
-
secondaryShippingSurcharge:
number
Extra handling cost in secondary currency for shipping the product.
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Details about pricing.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"itemDiscountInfos":{
"description":"Array of item promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"secondaryShippingSurcharge":{
"description":"Extra handling cost in secondary currency for shipping the product.",
"type":"number"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
additionalInfo:
object additionalInfo
Additional properties(if any) needed for any down stream system
-
amount:
number
Total Amount w.r.t to quantity.
-
chargeCode:
string
Charge code
-
chargeType:
string
Type of the charge
-
integrationId:
string
Integration id for this charge
-
isProductPrice:
boolean
This property tells which charge among others is Product price
-
name:
string
Name of the charge
-
priceType:
string
Price type for this charge. i.e., one-time, recurring or usage
-
unitPrice:
number
unit price of the item
{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}Nested Schema : additionalInfo
Type:
objectAdditional properties(if any) needed for any down stream system
Show Source
-
calculationInfo:
string
calculation info received from external system
{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
state:
string
The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"state":{
"description":"The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the item by the configurator system.
-
activationDate:
string
The activation date in ISO format.
-
addOnItem:
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
assetId:
string
The asset ID corresponding to the current item.
-
assetKey:
string
The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId:
string
The billing account ID associated to the current item.
-
billingProfileId:
string
The billing profile ID associated to the current item.
-
catalogRefId:
string
The reference ID of the catalog this commerce item references. Typically the SKU id.
-
commerceItems:
array commerceItems
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails:
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails:
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId:
string
The ID of the product.
-
quantity:
integer
The quantity included.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"assetId":{
"description":"The asset ID corresponding to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceItems":{
"type":"array",
"items":{
"properties":{
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU id.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}Nested Schema : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"properties":{
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice:
number
External price of this commerce item
-
externalPriceQuantity:
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge:
number
The external recurring price.
-
externalRecurringChargeDuration:
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency:
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted:
array currentPriceDetailsSorted
The current price details.
-
discountable:
boolean
Whether discountable.
-
discounted:
boolean
Whether the recurring charge price is discounted.
-
listPrice:
number
The monetary amount of the list price.
-
onSale:
boolean
Whether is on sale.
-
priceListId:
string
The price list ID used for pricing.
-
quantityDiscounted:
integer
The quantity discounted.
-
rawTotalPrice:
number
The raw total price of the recurring charge.
-
salePrice:
number
The sale price
-
shippingSurcharge:
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name(required):
string
The name to be associated with the externalData item.
-
values(required):
object values
The array of values associated with an externalData item.
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key(required):
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : additionalProperties
Type:
Show Source
object-
availabilityDate:
string
The availabilityDate for preordered/backordered quantity, for this inventory location
-
backOrderQuantity:
integer
The backordered quantity included, for this inventory location
-
inStockQuantity:
integer
The available quantity included that is 'in stock', for this inventory location
-
preOrderQuantity:
integer
The preordered quantity included, for this inventory location
{
"type":"object",
"properties":{
"availabilityDate":{
"description":"The availabilityDate for preordered/backordered quantity, for this inventory location",
"type":"string"
},
"preOrderQuantity":{
"description":"The preordered quantity included, for this inventory location",
"type":"integer"
},
"backOrderQuantity":{
"description":"The backordered quantity included, for this inventory location",
"type":"integer"
},
"inStockQuantity":{
"description":"The available quantity included that is 'in stock', for this inventory location",
"type":"integer"
}
}
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : itemDiscountInfos
Type:
arrayArray of item promotions affecting this item (read-only).
Show Source
{
"description":"Array of item promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
}Nested Schema : orderDiscountInfos
Type:
arrayArray of order promotions affecting this item (read-only).
Show Source
{
"description":"Array of order promotions affecting this item (read-only).",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this price info
-
range:
object range
Represents which specific items are covered by this price info.
-
secondaryCurrencyTaxAmount:
number
The tax amount in secondary currency
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this price info.
Show Source
-
highBound:
integer
The upper bound of the range this price info covers.
-
lowBound:
integer
The lower bound of the range this price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount of discount this item received from the promotion.
-
couponCodes:
array couponCodes
One or more coupon codes used to grant the item promotion providing the discount.
-
promotionId:
string
The promotion id that resulted in the discount.
{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}Nested Schema : couponCodes
Type:
arrayOne or more coupon codes used to grant the item promotion providing the discount.
Show Source
{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The amount of discount this item received from the promotion.
-
couponCodes:
array couponCodes
One or more coupon codes used to grant the order promotion providing the discount.
-
promotionId:
string
The promotion id that resulted in the discount.
{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion id that resulted in the discount.",
"type":"string"
}
}
}Nested Schema : couponCodes
Type:
arrayOne or more coupon codes used to grant the order promotion providing the discount.
Show Source
{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount for the recurring charge.
-
amountIsFinal:
boolean
Whether the recurring charge amount is final.
-
currencyCode:
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice:
number
The detailed unit price: amount / quantity. (read-only)
-
discounted:
boolean
Whether the price is discounted.
-
quantity:
integer
The number of items covered by this recurring charge price info
-
range:
object range
Represents which specific items are covered by this recurring charge price info.
-
tax:
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound:
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound:
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size:
integer
The number of items in this range, inclusive. (read-only)
{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
}Nested Schema : claimedCouponMultiPromotions
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which promotions were applied
{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}Nested Schema : orderCouponsMap
Type:
objectThe coupons that were claimed.
Show Source
-
couponCode:
object couponCode
Coupon Code.
{
"description":"The coupons that were claimed.",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}Nested Schema : orderImplicitDiscountList
Type:
arrayList of discounts.
Show Source
{
"description":"List of discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
}Nested Schema : unclaimedCouponMultiPromotions
Type:
objectThe coupons that were not claimed
Show Source
-
couponCode:
array couponCode
Coupon Code, corresponding to which some promotions were not applied
{
"description":"The coupons that were not claimed",
"type":"object",
"properties":{
"couponCode":{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}
}
}Nested Schema : unclaimedCouponsMap
Type:
arrayMap of unclaimed coupons.
Show Source
{
"description":"Map of unclaimed coupons.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}
}Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which promotions were applied
Show Source
{
"description":"Coupon Code, corresponding to which promotions were applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}Nested Schema : couponCode
Type:
objectCoupon Code.
Show Source
-
external:
boolean
States whether this promotion was applied by an external system (only present on external promotions).
-
promotionDesc:
string
Description of the promotion. Retained for backward compatibility.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
promotionLongDesc:
string
The description of the promotion.
-
promotionName:
string
The display name of the promotion.
-
totalAdjustment:
number
Total adjustment caused by the promotion.
{
"description":"Coupon Code.",
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}Nested Schema : couponCode
Type:
arrayCoupon Code, corresponding to which some promotions were not applied
Show Source
{
"description":"Coupon Code, corresponding to which some promotions were not applied",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Promotion description.
-
promotionId:
string
The Id of the promotion.
-
promotionLevel:
string
The promotion level.
{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"promotionDesc":{
"description":"Promotion description.",
"type":"string"
},
"promotionId":{
"description":"The Id of the promotion.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
couponInfo:
array couponInfo
The coupon Info.
-
promotionValue:
string
The value for promotion.
{
"type":"object",
"properties":{
"couponInfo":{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
},
"promotionValue":{
"description":"The value for promotion.",
"type":"string"
}
}
}Nested Schema : couponInfo
Type:
arrayThe coupon Info.
Show Source
{
"description":"The coupon Info.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
promotionDesc:
string
Description of the promotion.
-
promotionId:
string
Id of the promotion.
-
promotionLevel:
string
The promotion level.
-
totalAdjustment:
string
Total adjustment caused by the promotion.
{
"type":"object",
"properties":{
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment caused by the promotion.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion.",
"type":"string"
},
"promotionId":{
"description":"Id of the promotion.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
key:
string
Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua"
-
value:
string
Order marker value. In the case of a marketing campaign, it represents the actual unique campaign ID
{
"type":"object",
"properties":{
"value":{
"description":"Order marker value. In the case of a marketing campaign, it represents the actual unique campaign ID",
"type":"string"
},
"key":{
"description":"Order marker key. In a marketing campaign marker, a key signifies that it is a campaign marker. Also, it identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua\"",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(required):
number
The monetary amount of the payment.
-
amountAuthorized:
number
The monetary amount authorized.
-
authorizationStatus:
array authorizationStatus
Array of authorization status objects.
-
billingAddress:
array billingAddress
List of billing addresses associated with profile.
-
billTo:
object billTo
billTo details for invoice payment. Applicable for B2B orders only
-
creditCardNumber:
string
The last four digits of the credit card number. (only for TokenizedCreditCards)
-
creditCardType:
string
The type of the credit card. (only for TokenizedCreditCards)
-
currencyCode:
string
The three character currency code. For example: USD.
-
expirationDayOfMonth:
string
A string containing the two digit day of month when the credit card expires. (only for TokenizedCreditCards)
-
expirationMonth:
string
A string containing the two digit month when the credit card expires. (only for TokenizedCreditCards)
-
expirationYear:
string
A string containing the two or four digit year when the credit card expires. (only for TokenizedCreditCards)
-
externalId:
string
The ID for the payment group in an external system (like the OMS)
-
externalSourceId:
string
The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)
-
externalSubtype:
string
The subtype in the external system. Might be "VISA" for a PaymentGroup with an external type of "CreditCard". (only for ExternalPaymentGroups)
-
externalType:
string
The type in the external system. Might be "StoreCredit", "CreditCard", "Check", etc. (only for ExternalPaymentGroups).
-
id:
string
The internal ID of the payment group.
-
IIN:
string
The issuer identification number (first 6 digits) of the credit card.
-
paymentGroupClassType(required):
string
The class type of the payment group. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
-
paymentMethod(required):
string
The payment method. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
-
PONumber:
string
The purchase order number.
-
state:
string
The state of this payment group.
-
stateDetail:
string
Details about the state of this payment group.
-
submittedDate:
string
The date the payment was submitted.
-
token:
string
The CyberSource token string. (only for tokenizedCreditCard)
{
"type":"object",
"properties":{
"expirationYear":{
"description":"A string containing the two or four digit year when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"PONumber":{
"description":"The purchase order number.",
"type":"string"
},
"amountAuthorized":{
"description":"The monetary amount authorized.",
"type":"number"
},
"externalType":{
"description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
"type":"string"
},
"amount":{
"description":"The monetary amount of the payment.",
"type":"number"
},
"externalId":{
"description":"The ID for the payment group in an external system (like the OMS)",
"type":"string"
},
"creditCardType":{
"description":"The type of the credit card. (only for TokenizedCreditCards)",
"type":"string"
},
"expirationMonth":{
"description":"A string containing the two digit month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"submittedDate":{
"description":"The date the payment was submitted.",
"type":"string"
},
"authorizationStatus":{
"description":"Array of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
},
"token":{
"description":"The CyberSource token string. (only for tokenizedCreditCard)",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of the credit card.",
"type":"string"
},
"paymentGroupClassType":{
"description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"creditCardNumber":{
"description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
"type":"string"
},
"billTo":{
"description":"billTo details for invoice payment. Applicable for B2B orders only",
"type":"object",
"properties":{
"siteUseId":{
"description":"site use id",
"type":"string"
},
"customerAccountId":{
"description":"customer account id, (It corresponds to the billTo-address accountId property)",
"type":"string"
},
"partyId":{
"description":"party id ",
"type":"string"
}
}
},
"externalSubtype":{
"description":"The subtype in the external system. Might be \"VISA\" for a PaymentGroup with an external type of \"CreditCard\". (only for ExternalPaymentGroups)",
"type":"string"
},
"paymentMethod":{
"description":"The payment method. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"externalSourceId":{
"description":"The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)",
"type":"string"
},
"billingAddress":{
"description":"List of billing addresses associated with profile.",
"type":"array",
"items":{
"$ref":"#/definitions/order_billingAddress"
}
},
"id":{
"description":"The internal ID of the payment group.",
"type":"string"
},
"state":{
"description":"The state of this payment group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this payment group.",
"type":"string"
},
"currencyCode":{
"description":"The three character currency code. For example: USD.",
"type":"string"
},
"expirationDayOfMonth":{
"description":"A string containing the two digit day of month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
}
},
"required":[
"amount",
"paymentGroupClassType",
"paymentMethod"
]
}Nested Schema : authorizationStatus
Type:
arrayArray of authorization status objects.
Show Source
{
"description":"Array of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
}Nested Schema : billingAddress
Type:
arrayList of billing addresses associated with profile.
Show Source
{
"description":"List of billing addresses associated with profile.",
"type":"array",
"items":{
"$ref":"#/definitions/order_billingAddress"
}
}Nested Schema : billTo
Type:
objectbillTo details for invoice payment. Applicable for B2B orders only
Show Source
-
customerAccountId:
string
customer account id, (It corresponds to the billTo-address accountId property)
-
partyId:
string
party id
-
siteUseId:
string
site use id
{
"description":"billTo details for invoice payment. Applicable for B2B orders only",
"type":"object",
"properties":{
"siteUseId":{
"description":"site use id",
"type":"string"
},
"customerAccountId":{
"description":"customer account id, (It corresponds to the billTo-address accountId property)",
"type":"string"
},
"partyId":{
"description":"party id ",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary amount.
-
errorMessage:
string
The error message, if any.
-
transactionId:
string
The transaction ID.
-
transactionSuccess:
boolean
Whether the transaction was successful.
-
transactionTimestamp:
string
The timestamp of the transaction.
{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}Nested Schema : order_billingAddress
Type:
Show Source
object-
address1:
string
The address line 1 of address.
-
address2:
string
The address line 2 of address.
-
address3:
string
The address line 3 of address.
-
city:
string
The city of the address.
-
companyName:
string
Company name of the address.
-
country:
string
The country code of the address.
-
county:
string
The county of address.
-
email:
string
The email of the customer
-
faxNumber:
string
Fax number of the address.
-
firstName:
string
the first name of the Profile.
-
jobTitle:
string
The job title
-
lastName:
string
The last name of the profile.
-
middleName:
string
Middle name of the Profile.
-
ownerId:
string
The ID of the owner of this address
-
phoneNumber:
string
Phone number of the address.
-
postalCode:
string
The postal Code of address.
-
prefix:
string
Prefix of the address.
-
repositoryId:
string
The repository ID of the address.
-
state:
string
State code of the address.
-
suffix:
string
Suffix of the address.
{
"type":"object",
"properties":{
"lastName":{
"description":"The last name of the profile.",
"type":"string"
},
"country":{
"description":"The country code of the address.",
"type":"string"
},
"address3":{
"description":"The address line 3 of address.",
"type":"string"
},
"address2":{
"description":"The address line 2 of address.",
"type":"string"
},
"city":{
"description":"The city of the address.",
"type":"string"
},
"address1":{
"description":"The address line 1 of address.",
"type":"string"
},
"prefix":{
"description":"Prefix of the address.",
"type":"string"
},
"postalCode":{
"description":"The postal Code of address.",
"type":"string"
},
"companyName":{
"description":"Company name of the address.",
"type":"string"
},
"jobTitle":{
"description":"The job title",
"type":"string"
},
"county":{
"description":"The county of address.",
"type":"string"
},
"ownerId":{
"description":"The ID of the owner of this address",
"type":"string"
},
"suffix":{
"description":"Suffix of the address.",
"type":"string"
},
"firstName":{
"description":"the first name of the Profile.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number of the address.",
"type":"string"
},
"repositoryId":{
"description":"The repository ID of the address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number of the address.",
"type":"string"
},
"middleName":{
"description":"Middle name of the Profile.",
"type":"string"
},
"state":{
"description":"State code of the address.",
"type":"string"
},
"email":{
"description":"The email of the customer",
"type":"string"
}
}
}Nested Schema : orderTotalBySite
Type:
objectThe map containing order totals by site for all sites in a given order.
Nested Schema : loyaltyPrograms
Type:
arrayLoyalty Programs Information
Show Source
{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
}Nested Schema : shippingAddress
Type:
objectDefault shipping address
Show Source
-
address1:
string
Address Line 1.
-
address2:
string
Address Line 2.
-
address3:
string
Address Line 3.
-
city:
string
City.
-
country:
string
Country.
-
county:
string
Name of the county.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
state:
string
State.
{
"description":"Default shipping address",
"type":"object",
"properties":{
"country":{
"description":"Country.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
membershipId:
string
membershipId of the profile.
-
programId:
string
programId of Loyalty Program
-
programName:
string
programName of Loyalty Program
-
repositoryId:
string
repository Id
-
status:
string
status of Enrollment.
{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository Id",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's total e.g. Monthly.
-
total:
string
The total amount for the frequency.
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's tax e.g. Monthly.
-
tax:
string
The tax amount for the frequency.
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}Nested Schema : updateOrderRequestShippingGroups
Type:
Show Source
object-
actualShipDate:
string
The actual shipped date of this shipping group.
-
commerceItemRelationships:
array updateOrderRequestShippingGroupCommerceItemRelationships
-
description:
string
The description of this shipping group. Defaults to the ID.
-
email:
string
The email address of the person responsible for picking up the contents of this shipping group.
-
firstName:
string
The first name of the person responsible for picking up the contents of this shipping group.
-
handlingInstructions:
array handlingInstructions
Handling instructions. Currently read-only.
-
id:
string
The ID of this shipping group.
-
lastName:
string
The second name of the person responsible for picking up the contents of this shipping group.
-
locationId:
string
The inventory location Id for the hardgoodShippingGroup or inStorePickupShippingGroup
-
phoneNumber:
string
The phone number of the person responsible for picking up the contents of this shipping group.
-
priceInfo:
object priceInfo
The pricing details about this shipping group.
-
recurringChargePriceInfo:
object recurringChargePriceInfo
Recurring charge price information.
-
shipOnDate:
string
The date this shipping group is expected to ship upon.
-
shippingAddress:
object shippingAddress
The shipping address for this shipping group.
-
shippingGroupClassType:
string
The class type for the ShippingGroup. Currently must be "hardgoodShippingGroup".
-
shippingMethod:
string
The shipping method.
-
shipTo:
object shipTo
shipTo details for shipping.Applicable for B2B orders only
-
specialInstructions:
object specialInstructions
Special instructions for the shipping group. Keys and values are strings.
-
state:
string
The state of this shipping group.
-
stateDetail:
string
Details about the state of this shipping group.
-
submittedDate:
string
The date the shipping group was submitted.
-
trackingInfo:
array trackingInfo
An array that specifies the tracking info of shipping group. (read-only)
-
trackingNumber:
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.
{
"type":"object",
"properties":{
"lastName":{
"description":"The second name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method.",
"type":"string"
},
"description":{
"description":"The description of this shipping group. Defaults to the ID.",
"type":"string"
},
"submittedDate":{
"description":"The date the shipping group was submitted.",
"type":"string"
},
"priceInfo":{
"description":"The pricing details about this shipping group.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether this item is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary amount of the cost of raw shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts.",
"type":"string"
}
}
},
"firstName":{
"description":"The first name of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"phoneNumber":{
"description":"The phone number of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"shipOnDate":{
"description":"The date this shipping group is expected to ship upon.",
"type":"string"
},
"actualShipDate":{
"description":"The actual shipped date of this shipping group.",
"type":"string"
},
"trackingInfo":{
"description":"An array that specifies the tracking info of shipping group. (read-only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"The carrier name.",
"type":"string"
},
"trackingUrl":{
"description":"The tracking url.",
"type":"string"
},
"carrierId":{
"description":"The carrier id.",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
}
}
}
},
"specialInstructions":{
"description":"Special instructions for the shipping group. Keys and values are strings.",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string"
}
}
},
"locationId":{
"description":"The inventory location Id for the hardgoodShippingGroup or inStorePickupShippingGroup",
"type":"string"
},
"shippingAddress":{
"description":"The shipping address for this shipping group.",
"type":"object",
"properties":{
"country":{
"description":"Country.",
"type":"string"
},
"lastName":{
"description":"Last name.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"prefix":{
"description":"Prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"ownerId":{
"description":"The ID of the owner of this address.",
"type":"string"
},
"suffix":{
"description":"Suffix.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"The fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"description":"ID.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"email":{
"description":"The email address",
"type":"string"
}
}
},
"commerceItemRelationships":{
"$ref":"#/definitions/updateOrderRequestShippingGroupCommerceItemRelationships"
},
"id":{
"description":"The ID of this shipping group.",
"type":"string"
},
"state":{
"description":"The state of this shipping group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this shipping group.",
"type":"string"
},
"trackingNumber":{
"description":"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.",
"type":"string"
},
"handlingInstructions":{
"description":"Handling instructions. Currently read-only.",
"type":"array",
"items":{
"type":"string"
}
},
"email":{
"description":"The email address of the person responsible for picking up the contents of this shipping group.",
"type":"string"
},
"shipTo":{
"description":"shipTo details for shipping.Applicable for B2B orders only",
"type":"object",
"properties":{
"siteId":{
"description":"site id, (It corresponds to the shipTo-address externalId property)",
"type":"string"
},
"partyId":{
"description":"party id ",
"type":"string"
}
}
},
"shippingGroupClassType":{
"description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
"type":"string"
}
}
}Nested Schema : updateOrderRequestShippingGroupCommerceItemRelationships
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"charges":{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
}Nested Schema : handlingInstructions
Type:
arrayHandling instructions. Currently read-only.
Show Source
{
"description":"Handling instructions. Currently read-only.",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : priceInfo
Type:
objectThe pricing details about this shipping group.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether the amount is final.
-
currencyCode:
string
The currency code for the monetary amounts.
-
discounted:
boolean
Whether this item is discounted.
-
rawShipping:
number
The monetary amount of the cost of raw shipping.
-
secondaryCurrencyShippingAmount:
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount:
number
The secondary currency tax amount.
{
"description":"The pricing details about this shipping group.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether this item is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary amount of the cost of raw shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount:
number
The monetary amount of this recurring charge.
-
currencyCode:
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals:
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals:
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping:
number
Cost of shipping the product.
-
subTotal:
number
The sub-total price of the recurring charge.
-
tax:
number
Monetary tax amount.
-
total:
number
The total price of the recurring charge.
-
totalWithoutTax:
number
Total of recurring amount without tax included.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}Nested Schema : shippingAddress
Type:
objectThe shipping address for this shipping group.
Show Source
-
address1:
string
Address Line 1.
-
address2:
string
Address Line 2.
-
address3:
string
Address Line 3.
-
city:
string
City.
-
companyName:
string
Company name.
-
country:
string
Country.
-
county:
string
Name of the county.
-
email:
string
The email address
-
faxNumber:
string
The fax number.
-
firstName:
string
First name.
-
id:
string
ID.
-
jobTitle:
string
Job title.
-
lastName:
string
Last name.
-
middleName:
string
Middle name.
-
ownerId:
string
The ID of the owner of this address.
-
phoneNumber:
string
Phone number.
-
postalCode:
string
Postal code.
-
prefix:
string
Prefix.
-
state:
string
State.
-
suffix:
string
Suffix.
{
"description":"The shipping address for this shipping group.",
"type":"object",
"properties":{
"country":{
"description":"Country.",
"type":"string"
},
"lastName":{
"description":"Last name.",
"type":"string"
},
"address3":{
"description":"Address Line 3.",
"type":"string"
},
"address2":{
"description":"Address Line 2.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"address1":{
"description":"Address Line 1.",
"type":"string"
},
"prefix":{
"description":"Prefix.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"county":{
"description":"Name of the county.",
"type":"string"
},
"ownerId":{
"description":"The ID of the owner of this address.",
"type":"string"
},
"suffix":{
"description":"Suffix.",
"type":"string"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"The fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"id":{
"description":"ID.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"email":{
"description":"The email address",
"type":"string"
}
}
}Nested Schema : shipTo
Type:
objectshipTo details for shipping.Applicable for B2B orders only
Show Source
-
partyId:
string
party id
-
siteId:
string
site id, (It corresponds to the shipTo-address externalId property)
{
"description":"shipTo details for shipping.Applicable for B2B orders only",
"type":"object",
"properties":{
"siteId":{
"description":"site id, (It corresponds to the shipTo-address externalId property)",
"type":"string"
},
"partyId":{
"description":"party id ",
"type":"string"
}
}
}Nested Schema : specialInstructions
Type:
objectSpecial instructions for the shipping group. Keys and values are strings.
Show Source
{
"description":"Special instructions for the shipping group. Keys and values are strings.",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string"
}
}
}Nested Schema : trackingInfo
Type:
arrayAn array that specifies the tracking info of shipping group. (read-only)
Show Source
{
"description":"An array that specifies the tracking info of shipping group. (read-only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"The carrier name.",
"type":"string"
},
"trackingUrl":{
"description":"The tracking url.",
"type":"string"
},
"carrierId":{
"description":"The carrier id.",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount:
number
The monetary value.
-
availablePickupDate:
string
The items available store pickup date.
-
charges:
array charges
Charges applied on this commerce item if any.
-
commerceItemExternalId:
string
The referenced commerce item's external ID.
-
commerceItemId:
string
The referenced commerce item's internal ID.
-
id:
string
The native ID of this item.
-
inventoryLocationId:
string
Defines the inventory location that services the referenced commerce item.
-
preferredPickupDate:
string
The items preferred store pickup date.
-
quantity:
integer
The quantity of items referenced by this relationship.
-
relationshipType:
string
The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.
-
returnedQuantity:
integer
Number of referenced items that were returned.
{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"availablePickupDate":{
"description":"The items available store pickup date.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"charges":{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"preferredPickupDate":{
"description":"The items preferred store pickup date.",
"type":"string"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}Nested Schema : charges
Type:
arrayCharges applied on this commerce item if any.
Show Source
{
"description":"Charges applied on this commerce item if any.",
"type":"array",
"items":{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
additionalInfo:
object additionalInfo
Additional properties(if any) needed for any down stream system
-
amount:
number
Total Amount w.r.t to quantity.
-
chargeCode:
string
Charge code
-
chargeType:
string
Type of the charge
-
integrationId:
string
Integration id for this charge
-
isProductPrice:
boolean
This property tells which charge among others is Product price
-
name:
string
Name of the charge
-
priceType:
string
Price type for this charge. i.e., one-time, recurring or usage
-
unitPrice:
number
unit price of the item
{
"type":"object",
"properties":{
"unitPrice":{
"description":"unit price of the item",
"type":"number"
},
"amount":{
"description":"Total Amount w.r.t to quantity.",
"type":"number"
},
"isProductPrice":{
"description":"This property tells which charge among others is Product price",
"type":"boolean"
},
"name":{
"description":"Name of the charge",
"type":"string"
},
"chargeType":{
"description":"Type of the charge",
"type":"string"
},
"priceType":{
"description":"Price type for this charge. i.e., one-time, recurring or usage",
"type":"string"
},
"additionalInfo":{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
},
"integrationId":{
"description":"Integration id for this charge",
"type":"string"
},
"chargeCode":{
"description":"Charge code",
"type":"string"
}
}
}Nested Schema : additionalInfo
Type:
objectAdditional properties(if any) needed for any down stream system
Show Source
-
calculationInfo:
string
calculation info received from external system
{
"description":"Additional properties(if any) needed for any down stream system",
"type":"object",
"properties":{
"calculationInfo":{
"description":"calculation info received from external system",
"type":"string"
}
}
}Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's total e.g. Monthly.
-
total:
string
The total amount for the frequency.
{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
frequency:
string
The frequency for the item's tax e.g. Monthly.
-
tax:
string
The tax amount for the frequency.
{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
carrierId:
string
The carrier id.
-
carrierName:
string
The carrier name.
-
trackingNumber:
string
The tracking number.
-
trackingUrl:
string
The tracking url.
{
"type":"object",
"properties":{
"carrierName":{
"description":"The carrier name.",
"type":"string"
},
"trackingUrl":{
"description":"The tracking url.",
"type":"string"
},
"carrierId":{
"description":"The carrier id.",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
order:
string
Whether this property should be sorted ascending ("asc") or descending ("dsc").
-
property:
string
The name of the property to use for sorting.
{
"type":"object",
"properties":{
"property":{
"description":"The name of the property to use for sorting.",
"type":"string"
},
"order":{
"description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
"type":"string"
}
}
}Default Response
The error response
Body ()
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"type":{
"description":"The URI to the HTTP state code definition",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"errors":{
"description":"An optional list of errors if multiple errors were encountered",
"type":"array",
"items":{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
{
"description":"An optional list of errors if multiple errors were encountered",
"type":"array",
"items":{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}