- REST API for Oracle Commerce Cloud
- Tasks
- Store
- Orders
put
/ccstore/v1/orders/{id}
Updates the order, for the given order id, with the provided data and prices the order again; returning the updated order.
Dynamic Properties of order and order line items can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue").
Note: The minimum required properties, in the payload, for this endpoint call (updateOrder) to be successful - granted it is an empty order, are shippingGroup, shippingMethod and shoppingCart. If the order has already been created there is no minimum request payload, just correctly enter the property you wish to update.
Prerequisite: The user must be logged in. See REST API Authentication.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The ID of order to update.
Header Parameters
-
X-CCAsset-Language: string
Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
-
X-CCOrganization: string
Current organization context of the logged in user
Body ()
Root Schema : updateOrder_request
Type:
Show Source
object
-
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.
-
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.
-
sourceSystem:
string
The system where the order originated.
-
state:
string
The state of the order.
-
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"
},
"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"
},
"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"
},
"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"
}
},
"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"
}
}
},
"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"
}
}
},
"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",
"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"
},
"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":{
},
"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"
}
],
"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"
},
"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",
"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"
},
"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":{
},
"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"
}
],
"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"
},
"profileId":"se-570031",
"siteId":"siteUS",
"markers":[
{
"value":"78900",
"key":"campaign_eloqua"
}
]
}
Nested Schema : commerceItems
Type:
array
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.
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"
},
"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 : markers
Type:
array
Order 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:
array
The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
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"
},
"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:
object
Pricing 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:
object
Basic 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:
object
Recurring 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 : taxPriceInfo
Type:
object
The 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.
-
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"
},
"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 : 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Additional 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:
object
Details 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:
object
Recurring 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:
object
Additional 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 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
array
External 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:
object
Details 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:
object
Details 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:
object
Recurring 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:
object
Additional 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
object
Represents 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:
object
The 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:
array
The 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:
array
Array 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:
array
Array 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:
object
Represents 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:
array
One 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:
array
One 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:
array
The 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:
object
Represents 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
-
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.
-
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"
},
"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:
array
Array 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:
array
List 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 : 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:
object
The map containing order totals by site for all sites in a given order.
Nested Schema : loyaltyPrograms
Type:
array
Loyalty 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:
object
Default 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:
array
The 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:
array
The 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.
-
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.
-
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"
}
}
},
"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"
},
"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"
},
"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:
array
Handling instructions. Currently read-only.
Show Source
{
"description":"Handling instructions. Currently read-only.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : priceInfo
Type:
object
The 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:
object
Recurring 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:
object
The 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 : specialInstructions
Type:
object
Special 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:
array
An 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.
-
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"
},
"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 : frequencyAmountTotals
Type:
array
The 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:
array
The 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"
}
}
}
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Body ()
Root Schema : updateOrder_response
Type:
Show Source
object
-
allowAlternateCurrency:
boolean
A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.
-
approvalSystemMessages:
array approvalSystemMessages
The array of messages which are stored during order processing
-
billingMethod:
object billingMethod
billing Method information of the order.
-
creationDate:
string
Date on which the Order was created.
-
creationSiteId:
string
The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.
-
creationTime:
number
Order creation time.
-
discountInfo:
object discountInfo
Discount information.
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties for the order along with meta-data.
-
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.
-
giftWithPurchaseInfo:
array giftWithPurchaseInfo
Gift Selection Information
-
giftWithPurchaseOrderMarkers:
array giftWithPurchaseOrderMarkers
Gift With Purchase order markers information
-
id:
string
Commerce id for this duplicated order.
-
orderComments:
array orderComments
The list of all logged comments for the order.
-
paymentGroup:
object paymentGroup
Payment Group for the order.
-
paymentGroups:
array paymentGroups
List of payment Groups for the order.
-
payShippingInSecondaryCurrency:
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay Shipping in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
-
payTaxInSecondaryCurrency:
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. In addition to this flag, if the allowAlternate Currency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
-
priceInfo:
object priceInfo
Price information of the order.
-
priceListGroup:
object priceListGroup
PriceList group of the order.
-
profile:
object profile
Profile Information for the order.
-
profileId:
string
The Repository Id of the profile to which this Order belongs to.
-
returnRequests:
array returnRequests
The list of the requests raised for the order.
-
secondaryCurrencyCode:
string
The currency code of secondary currency associated with the site.
-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingGroups:
array shippingGroups
Shipping Group information
-
shippingMethod:
object shippingMethod
Shipping method information.
-
shoppingCart:
object shoppingCart
Shopping cart information.
-
siteId:
string
The ID of the site on which the order was placed.
-
sourceSystem:
string
The system where the order originated.
-
state:
integer
The order state.
-
stateDetailsAsUser:
string
Order State description for this order.Incorporates changes made by merchant from admin UI, if any.
-
taxPriceInfo:
object taxPriceInfo
The tax pricing details for the order.
{
"properties":{
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"type":"string"
},
"orderComments":{
"description":"The list of all logged comments for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the comment record.",
"type":"string"
},
"comment":{
"description":"The comment string.",
"type":"string"
},
"creationDate":{
"description":"Date on which the comment was created.",
"type":"string"
}
}
}
},
"creationTime":{
"description":"Order creation time.",
"type":"number"
},
"sourceSystem":{
"description":"The system where the order originated.",
"type":"string"
},
"dynamicProperties":{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
},
"paymentGroups":{
"description":"List of payment Groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"zero_value_auto_authorized":{
"description":"The Payment Group is auto authorized without any payment details for zero amount. e.g. true",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
},
"payTaxInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. In addition to this flag, if the allowAlternate Currency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.",
"type":"boolean"
},
"priceInfo":{
"description":"Price information of the order.",
"type":"object",
"properties":{
"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 raw number that represents the price.",
"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"
},
"shippingSurchargeValue":{
"description":"The total shiiping surcharge value in the order",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"billing":{
"description":"The billing cost of the order.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"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"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"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"
},
"paymentGroup":{
"description":"Payment Group for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"The credit card type.",
"type":"string"
},
"zero_value_auto_authorized":{
"description":"The Payment Group is auto authorized without any payment details for zero amount. e.g. true",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
},
"shoppingCart":{
"description":"Shopping cart information.",
"type":"object",
"properties":{
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"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"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"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"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child 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"
},
"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 sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"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"
},
"commerceItemId":{
"description":"Commerce Item id of the configurable product",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"Indicates if product is on Sale or not.",
"type":"boolean"
},
"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"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"repositoryId":{
"description":"The repository id",
"type":"string"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"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"
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"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"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
}
}
}
}
}
},
"id":{
"description":"Commerce id for this duplicated order.",
"type":"string"
},
"state":{
"description":"The order state.",
"type":"integer"
},
"stateDetailsAsUser":{
"description":"Order State description for this order.Incorporates changes made by merchant from admin UI, if any.",
"type":"string"
},
"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 or not the price was discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether or not 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":{
"description":"Shipping Group information",
"type":"array",
"items":{
"type":"object",
"properties":{
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"string"
},
"secondaryCurrencyShippingAmount":{
"description":"shipping amount in secondary currency.",
"type":"string"
},
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"quantity":{
"description":"quantity of the product.",
"type":"integer"
},
"productId":{
"description":"Id of the product.",
"type":"string"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"catRefId":{
"description":"catRefId (skuId) of the product.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
},
"required":[
"items"
]
}
},
"creationSiteId":{
"description":"The ID of the site on which the order was created on. This may differ to siteId value if the site is part of a cart sharing group.",
"type":"string"
},
"allowAlternateCurrency":{
"description":"A site level setting which enables the shopper to split the payment amount in points and monetary currency, irrespective of the order level price list group.",
"type":"boolean"
},
"approvalSystemMessages":{
"description":"The array of messages which are stored during order processing",
"type":"array",
"items":{
"type":"string"
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"string"
},
"secondaryCurrencyShippingAmount":{
"description":"shipping amount in secondary currency.",
"type":"string"
},
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"billingMethod":{
"description":"billing Method information of the order.",
"type":"object",
"properties":{
"cost":{
"description":"billing Cost for this order.",
"type":"number"
},
"displayName":{
"description":"billing method display name for this billing method.",
"type":"string"
},
"value":{
"description":"billing method name for this order.",
"type":"string"
}
}
},
"profile":{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email Address corresponding to the profile.",
"type":"string"
}
}
},
"priceListGroup":{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
}
}
},
"returnRequests":{
"description":"The list of the requests raised for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
},
"payShippingInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay Shipping in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.",
"type":"boolean"
},
"creationDate":{
"description":"Date on which the Order was created.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
},
"profileId":{
"description":"The Repository Id of the profile to which this Order belongs to.",
"type":"string"
},
"giftWithPurchaseInfo":{
"description":"Gift Selection Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"Quantity of gift that the shopper still needs to select.",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of gift like sku, product, category, skuContentGroup or productContentGroup.",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the gift usually the repository ID of the gift type.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
}
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"giftWithPurchaseOrderMarkers":{
"description":"Gift With Purchase order markers information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of gift like sku, product, category, skuContentGroup or productContentGroup.",
"type":"string"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the gwp order marker.",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site..",
"type":"number"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"key":{
"description":"atg.gwp.",
"type":"string"
}
}
}
}
}
}
Nested Schema : approvalSystemMessages
Type:
array
The array of messages which are stored during order processing
Show Source
{
"description":"The array of messages which are stored during order processing",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : billingMethod
Type:
object
billing Method information of the order.
Show Source
-
cost:
number
billing Cost for this order.
-
displayName:
string
billing method display name for this billing method.
-
value:
string
billing method name for this order.
{
"description":"billing Method information of the order.",
"type":"object",
"properties":{
"cost":{
"description":"billing Cost for this order.",
"type":"number"
},
"displayName":{
"description":"billing method display name for this billing method.",
"type":"string"
},
"value":{
"description":"billing method name for this order.",
"type":"string"
}
}
}
Nested Schema : discountInfo
Type:
object
Discount information.
Show Source
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
}
Nested Schema : dynamicProperties
Type:
array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
}
Nested Schema : giftWithPurchaseInfo
Type:
array
Gift Selection Information
Show Source
{
"description":"Gift Selection Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"Quantity of gift that the shopper still needs to select.",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of gift like sku, product, category, skuContentGroup or productContentGroup.",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the gift usually the repository ID of the gift type.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
}
}
}
}
Nested Schema : giftWithPurchaseOrderMarkers
Type:
array
Gift With Purchase order markers information
Show Source
{
"description":"Gift With Purchase order markers information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of gift like sku, product, category, skuContentGroup or productContentGroup.",
"type":"string"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the gwp order marker.",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site..",
"type":"number"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"key":{
"description":"atg.gwp.",
"type":"string"
}
}
}
}
Nested Schema : orderComments
Type:
array
The list of all logged comments for the order.
Show Source
{
"description":"The list of all logged comments for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the comment record.",
"type":"string"
},
"comment":{
"description":"The comment string.",
"type":"string"
},
"creationDate":{
"description":"Date on which the comment was created.",
"type":"string"
}
}
}
}
Nested Schema : paymentGroup
Type:
object
Payment Group for the order.
Show Source
-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
The credit card type.
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
-
zero_value_auto_authorized:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
{
"description":"Payment Group for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"The credit card type.",
"type":"string"
},
"zero_value_auto_authorized":{
"description":"The Payment Group is auto authorized without any payment details for zero amount. e.g. true",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
Nested Schema : paymentGroups
Type:
array
List of payment Groups for the order.
Show Source
{
"description":"List of payment Groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"zero_value_auto_authorized":{
"description":"The Payment Group is auto authorized without any payment details for zero amount. e.g. true",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
}
Nested Schema : priceInfo
Type:
object
Price information of the order.
Show Source
-
amount:
number
The raw number that represents the price.
-
billing:
number
The billing cost of the order.
-
currencyCode:
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
-
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. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
-
secondaryCurrencyShippingAmount:
number
This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
-
secondaryCurrencyShippingSurchargeValue:
number
The shipping surcharges added at item level in monetary currency.
-
secondaryCurrencyTaxAmount:
number
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. 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. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
-
shippingSurchargeValue:
number
The total shiiping surcharge value in the order
-
subTotal:
number
The subtotal of the order before applying order-level promotions.
-
tax:
number
The tax on the order.
-
taxExclusiveAmount:
number
Total excluding shipping and tax in monetary currency
-
total:
number
The current working total, including all promotions, tax, and billing costs.
{
"description":"Price information of the order.",
"type":"object",
"properties":{
"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 raw number that represents the price.",
"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"
},
"shippingSurchargeValue":{
"description":"The total shiiping surcharge value in the order",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The tax on the order.",
"type":"number"
},
"subTotal":{
"description":" The subtotal of the order before applying order-level promotions.",
"type":"number"
},
"billing":{
"description":"The billing cost of the order.",
"type":"number"
},
"total":{
"description":"The current working total, including all promotions, tax, and billing costs.",
"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"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
}
}
}
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
Show Source
-
active:
boolean
Active status of pricelist group.
-
currency:
object currency
Currency of the PriceList group.
-
deleted:
boolean
Pricelist group deleted status.
-
displayName:
string
Display Name.
-
id:
string
Id.
-
locale:
string
Locale.
-
repositoryId:
string
Repository Id.
{
"description":"PriceList group of the order.",
"type":"object",
"properties":{
"deleted":{
"description":"Pricelist group deleted status.",
"type":"boolean"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"active":{
"description":"Active status of pricelist group.",
"type":"boolean"
},
"currency":{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
},
"id":{
"description":"Id.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
}
}
}
Nested Schema : profile
Type:
object
Profile Information for the order.
Show Source
-
email:
string
Email Address corresponding to the profile.
-
firstName:
string
First name of profile.
-
lastName:
string
Last name of profile.
-
middleName:
string
Middle name of profile.
-
organization:
object organization
The Organization associated with the B2B customer profile.
{
"description":"Profile Information for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name of profile.",
"type":"string"
},
"firstName":{
"description":"First name of profile.",
"type":"string"
},
"organization":{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"email":{
"description":"Email Address corresponding to the profile.",
"type":"string"
}
}
}
Nested Schema : returnRequests
Type:
array
The list of the requests raised for the order.
Show Source
{
"description":"The list of the requests raised for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
}
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this shipping address.
-
state_ISOCode:
string
The state ISO code of the shipping address.
-
suffix:
string
Suffix for this shipping address.
{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
}
Nested Schema : shippingGroups
Type:
array
Shipping Group information
Show Source
{
"description":"Shipping Group information",
"type":"array",
"items":{
"type":"object",
"properties":{
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"string"
},
"secondaryCurrencyShippingAmount":{
"description":"shipping amount in secondary currency.",
"type":"string"
},
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"quantity":{
"description":"quantity of the product.",
"type":"integer"
},
"productId":{
"description":"Id of the product.",
"type":"string"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"catRefId":{
"description":"catRefId (skuId) of the product.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
},
"required":[
"items"
]
}
}
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in Monetary Currency. 2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled 3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.
-
value:
string
method type of shipment.
{
"description":"Shipping method information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"string"
},
"secondaryCurrencyShippingAmount":{
"description":"shipping amount in secondary currency.",
"type":"string"
},
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
}
Nested Schema : shoppingCart
Type:
object
Shopping cart information.
Show Source
-
items:
array items
Items in the cart.
{
"description":"Shopping cart information.",
"type":"object",
"properties":{
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"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"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"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"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child 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"
},
"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 sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"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"
},
"commerceItemId":{
"description":"Commerce Item id of the configurable product",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"Indicates if product is on Sale or not.",
"type":"boolean"
},
"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"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"repositoryId":{
"description":"The repository id",
"type":"string"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"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"
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"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"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
}
}
}
}
}
}
Nested Schema : taxPriceInfo
Type:
object
The tax pricing details for the order.
Show Source
-
amount:
number
The monetary amount.
-
amountIsFinal:
boolean
Whether or not 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 or not the price was discounted.
-
districtTax:
number
Tax amount for the district.
-
secondaryCurrencyTaxAmount:
number
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in Monetary Currency. 2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled 3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary 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 or not the price was discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether or not 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 : orderCouponsMap
Type:
object
The 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:
array
List 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 : unclaimedCouponsMap
Type:
array
Map 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:
object
Coupon 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 : 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:
array
The 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
-
id:
string
The ID of the dynamic property.
-
value:
string
The value of the dynamic property.
{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
giftWithPurchaseDetail:
string
String identifying the gift usually the repository ID of the gift type.
-
giftWithPurchaseIdentifier:
integer
An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
giftWithPurchaseQuantityAvailableForSelection:
number
Quantity of gift that the shopper still needs to select.
-
giftWithPurchaseType:
string
The type of gift like sku, product, category, skuContentGroup or productContentGroup.
-
promotionDesc:
string
The promotion description.
-
promotionId:
string
The gift with purchase promotion id
{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"Quantity of gift that the shopper still needs to select.",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of gift like sku, product, category, skuContentGroup or productContentGroup.",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the gift usually the repository ID of the gift type.",
"type":"string"
},
"promotionDesc":{
"description":"The promotion description.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion id",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity:
number
The quantity of free sku for this gift selection that has already been auto added to the order.
-
autoRemove:
boolean
Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
-
data:
string
Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
-
failedQuantity:
number
The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site..
-
giftDetail:
string
String identifying the free gift, usually the repository id of the gift type.
-
giftType:
string
The type of gift like sku, product, category, skuContentGroup or productContentGroup.
-
key:
string
atg.gwp.
-
quantity:
number
The total quantity of sku for this gift selection.
-
removedQuantity:
number
The amount of free quantity that has since been manually removed by a Shopper.
-
repositoryId:
string
The repository id of the gwp order marker.
-
selectedQuantity:
number
The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
-
targetedQuantity:
number
The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
-
value:
string
The GWP promotion id.
{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"number"
},
"data":{
"description":"Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of gift like sku, product, category, skuContentGroup or productContentGroup.",
"type":"string"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository id of the gift type.",
"type":"string"
},
"repositoryId":{
"description":"The repository id of the gwp order marker.",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site..",
"type":"number"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"key":{
"description":"atg.gwp.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
comment:
string
The comment string.
-
creationDate:
string
Date on which the comment was created.
-
repositoryId:
string
The repository id of the comment record.
{
"type":"object",
"properties":{
"repositoryId":{
"description":"The repository id of the comment record.",
"type":"string"
},
"comment":{
"description":"The comment string.",
"type":"string"
},
"creationDate":{
"description":"Date on which the comment was created.",
"type":"string"
}
}
}
Nested Schema : billingAddress
Type:
object
Billing address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this billing address.
-
state_ISOCode:
string
The state ISO code of the shipping address.
-
suffix:
string
Suffix for this billing address.
{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
amount:
number
The amount associated with this Payment Group.
-
amountAuthorized:
number
The amount authorized with this Payment Group.
-
billingAddress:
object billingAddress
Billing address for the order.
-
cardNumber:
string
The masked credit card number.
-
cardType:
string
Payment method. e.g. physicalGiftCard/ creditCard
-
firstName:
string
First name associated with this Payment Group.
-
lastName:
string
Last name associated with this Payment Group.
-
paidAmount:
number
The amount that has been debited to-date for this Payment Group.
-
paymentGroupId:
integer
Id of this payment Group.
-
paymentState:
string
The Payment Group state.
-
paymentStateDetailsAsUser:
string
The payment state description as string.
-
refundAmount:
number
The amount that has been credited to-date for this Payment Group.
-
token:
string
Token associated with this Payment Group.
-
totalDue:
number
The current working total order price including all discounts, tax, and billing costs.
-
uiIntervention:
string
This decides whether the client has to do some intervention for payment. e.g. SOP
-
zero_value_auto_authorized:
string
The Payment Group is auto authorized without any payment details for zero amount. e.g. true
{
"type":"object",
"properties":{
"lastName":{
"description":"Last name associated with this Payment Group.",
"type":"string"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"totalDue":{
"description":"The current working total order price including all discounts, tax, and billing costs.",
"type":"number"
},
"cardType":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard",
"type":"string"
},
"zero_value_auto_authorized":{
"description":"The Payment Group is auto authorized without any payment details for zero amount. e.g. true",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
},
"paymentGroupId":{
"description":"Id of this payment Group.",
"type":"integer"
},
"firstName":{
"description":"First name associated with this Payment Group.",
"type":"string"
},
"paymentStateDetailsAsUser":{
"description":"The payment state description as string.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"paymentState":{
"description":"The Payment Group state.",
"type":"string"
},
"paidAmount":{
"description":"The amount that has been debited to-date for this Payment Group.",
"type":"number"
},
"cardNumber":{
"description":"The masked credit card number.",
"type":"string"
},
"refundAmount":{
"description":"The amount that has been credited to-date for this Payment Group.",
"type":"number"
}
}
}
Nested Schema : billingAddress
Type:
object
Billing address for the order.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
email:
string
Email for this billing address.
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this billing address.
-
state_ISOCode:
string
The state ISO code of the shipping address.
-
suffix:
string
Suffix for this billing address.
{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
}
Nested Schema : currency
Type:
object
Currency of the PriceList group.
Show Source
-
currencyCode:
string
Currency Code.
-
displayName:
string
Display Name.
-
fractionalDigits:
integer
Fractional Digits.
-
numericCode:
string
Numeric Code.
-
repositoryId:
string
Repository Id.
-
symbol:
string
currency Symbol.
{
"description":"Currency of the PriceList group.",
"type":"object",
"properties":{
"symbol":{
"description":"currency Symbol.",
"type":"string"
},
"displayName":{
"description":"Display Name.",
"type":"string"
},
"repositoryId":{
"description":"Repository Id.",
"type":"string"
},
"fractionalDigits":{
"description":"Fractional Digits.",
"type":"integer"
},
"currencyCode":{
"description":"Currency Code.",
"type":"string"
},
"numericCode":{
"description":"Numeric Code.",
"type":"string"
}
}
}
Nested Schema : organization
Type:
object
The Organization associated with the B2B customer profile.
Show Source
-
id:
string
The id of the organization.
-
name:
string
The name of of the organization.
{
"description":"The Organization associated with the B2B customer profile.",
"type":"object",
"properties":{
"name":{
"description":"The name of of the organization.",
"type":"string"
},
"id":{
"description":"The id of the organization.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
createdDate:
string
The creation date of the return request.
-
returnRequestId:
string
The return request id.
-
state:
string
The status of the return request.
-
stateKey:
string
State key for return request which is not localized
-
totalRefund:
number
The total amount to be refunded on return.
-
totalReturnQuantity:
integer
The total quantity for which return request has been raised.
{
"type":"object",
"properties":{
"returnRequestId":{
"description":"The return request id.",
"type":"string"
},
"createdDate":{
"description":"The creation date of the return request.",
"type":"string"
},
"totalRefund":{
"description":"The total amount to be refunded on return.",
"type":"number"
},
"state":{
"description":"The status of the return request.",
"type":"string"
},
"totalReturnQuantity":{
"description":"The total quantity for which return request has been raised.",
"type":"integer"
},
"stateKey":{
"description":"State key for return request which is not localized",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
email:
string
The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
firstName:
string
The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
items(required):
array items
Items in the cart.
-
lastName:
string
The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
middleName:
string
The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
phoneNumber:
string
The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).
-
shippingAddress:
object shippingAddress
shipping address for the order.
-
shippingMethod:
object shippingMethod
Shipping method information.
-
store:
object store
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
-
trackingInfo:
array trackingInfo
Tracking Information for the Order.
-
trackingNumber:
string
Shipping tracking number.
-
type:
string
The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup
{
"type":"object",
"properties":{
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shippingMethod":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"string"
},
"secondaryCurrencyShippingAmount":{
"description":"shipping amount in secondary currency.",
"type":"string"
},
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
},
"shippingAddress":{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"quantity":{
"description":"quantity of the product.",
"type":"integer"
},
"productId":{
"description":"Id of the product.",
"type":"string"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"catRefId":{
"description":"catRefId (skuId) of the product.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"trackingNumber":{
"description":"Shipping tracking number.",
"type":"string"
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
},
"required":[
"items"
]
}
Nested Schema : items
Type:
array
Items in the cart.
Show Source
{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"quantity":{
"description":"quantity of the product.",
"type":"integer"
},
"productId":{
"description":"Id of the product.",
"type":"string"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"catRefId":{
"description":"catRefId (skuId) of the product.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
}
Nested Schema : shippingAddress
Type:
object
shipping address for the order.
Show Source
-
address1:
string
Address Line 1 for this shipping address.
-
address2:
string
Address Line 2 for this shipping address.
-
address3:
string
Address Line 3 for this shipping address.
-
city:
string
City for this shipping address.
-
companyName:
string
Company name for this shipping address.
-
country:
string
Country for this shipping address.
-
county:
string
County for this shipping address.
-
email:
string
Email for this shipping address.
-
faxNumber:
string
Fax number for this shipping address.
-
firstName:
string
First name for this shipping address.
-
jobTitle:
string
Job title for this shipping address.
-
lastName:
string
Last name for this shipping address.
-
middleName:
string
Middle name for this shipping address.
-
phoneNumber:
string
Phone number for this shipping address.
-
postalCode:
string
Postal code for this shipping address.
-
prefix:
string
Prefix for this shipping address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state:
string
State for this shipping address.
-
state_ISOCode:
string
The state ISO code of the shipping address.
-
suffix:
string
Suffix for this shipping address.
{
"description":"shipping address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this shipping address.",
"type":"string"
},
"country":{
"description":"Country for this shipping address.",
"type":"string"
},
"address3":{
"description":"Address Line 3 for this shipping address.",
"type":"string"
},
"address2":{
"description":"Address Line 2 for this shipping address.",
"type":"string"
},
"city":{
"description":"City for this shipping address.",
"type":"string"
},
"address1":{
"description":"Address Line 1 for this shipping address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this shipping address.",
"type":"string"
},
"companyName":{
"description":"Company name for this shipping address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this shipping address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this shipping address.",
"type":"string"
},
"county":{
"description":"County for this shipping address.",
"type":"string"
},
"suffix":{
"description":"Suffix for this shipping address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this shipping address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this shipping address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this shipping address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this shipping address.",
"type":"string"
},
"state":{
"description":"State for this shipping address.",
"type":"string"
},
"email":{
"description":"Email for this shipping address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
}
}
Nested Schema : shippingMethod
Type:
object
Shipping method information.
Show Source
-
cost:
number
shipping cost.
-
displayName:
string
Display Name of shipment.
-
secondaryCurrencyShippingAmount:
string
shipping amount in secondary currency.
-
secondaryCurrencyTaxAmount:
string
This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in Monetary Currency. 2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled 3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.
-
value:
string
method type of shipment.
{
"description":"Shipping method information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \n\nPrerequisites for the value in this Attribute: \n1. PriceList configured for the site is in Monetary Currency. \n\n2. TaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled\n\n3. If the tax is included in the price of the item, then ths value presents only shipping tax in monetary currency.",
"type":"string"
},
"secondaryCurrencyShippingAmount":{
"description":"shipping amount in secondary currency.",
"type":"string"
},
"cost":{
"description":"shipping cost.",
"type":"number"
},
"displayName":{
"description":"Display Name of shipment.",
"type":"string"
},
"value":{
"description":"method type of shipment.",
"type":"string"
}
}
}
Nested Schema : store
Type:
object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
-
address1:
string
Address line 1 of the store.
-
address2:
string
Address line 2 of the store.
-
address3:
string
Address line 3 of the store.
-
city:
string
The city in which the store resides.
-
country:
string
The country in which the store resides.
-
county:
string
The county in which the store resides.
-
email:
string
The email address of the store.
-
faxNumber:
string
The fax number of the store.
-
hours:
string
The opening hours of the store.
-
locationId:
string
The location id of the store.
-
name:
string
Name of the store.
-
phoneNumber:
string
The phone number of the store.
-
postalCode:
string
The postal code of the store.
-
stateAddress:
string
The state in which the store resides.
{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
}
Nested Schema : trackingInfo
Type:
array
Tracking Information for the Order.
Show Source
{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
}
Nested Schema : items
Type:
Show Source
object
-
availablePickupDate:
string
The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
catRefId(required):
string
catRefId (skuId) of the product.
-
preferredPickupDate:
string
The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
-
productId(required):
string
Id of the product.
-
quantity(required):
integer
quantity of the product.
-
siteId:
string
The ID of the site on which the item was added.
-
skuProperties:
array skuProperties
Sku properties Information
-
variant:
array variant
Product Variant Information.
{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"quantity":{
"description":"quantity of the product.",
"type":"integer"
},
"productId":{
"description":"Id of the product.",
"type":"string"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"catRefId":{
"description":"catRefId (skuId) of the product.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
Nested Schema : skuProperties
Type:
array
Sku properties Information
Show Source
{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
}
Nested Schema : variant
Type:
array
Product Variant Information.
Show Source
{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
}
Nested Schema : items
Type:
Show Source
object
-
id:
string
ID of the Dynamic SKU Property.
-
name:
string
Name of the Dynamic SKU Property.
-
propertyType:
string
Type that indicates whether it is a base or a custom SKU property,
-
value:
string
Value of the Dynamic SKU Property.
{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
carrierId:
string
Carrier Id for Tracking.
-
carrierName:
string
Carrier Name for Tracking.
-
carrierUrl:
string
Carrier URL for Tracking.
-
trackingNumber:
string
Tracking Number.
{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier Id for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
Nested Schema : items
Type:
array
Items in the cart.
Show Source
{
"description":"Items in the cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"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"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"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"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child 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"
},
"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 sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"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"
},
"commerceItemId":{
"description":"Commerce Item id of the configurable product",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"Indicates if product is on Sale or not.",
"type":"boolean"
},
"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"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"repositoryId":{
"description":"The repository id",
"type":"string"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"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"
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"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"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
}
}
}
}
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.
-
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.
-
catRefId:
string
Catalog Reference Id of commerce item.
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
Commerce Item id of the configurable product
-
configuratorId:
string
Configuration id of the configurable product
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
discountInfo:
object discountInfo
Discount information.
-
displayName:
string
Display name of commerce item.
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
giftWithPurchaseCommerceItemMarkers:
array giftWithPurchaseCommerceItemMarkers
The array of giftWithPurchaseCommerceItemMarkers.
-
imageInfo:
object imageInfo
Shipping method information.
-
onSale:
boolean
Indicates if product is on Sale or not.
-
parentAssetKey:
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
price:
number
The raw number that represents the price.
-
productId:
string
Product Id of commerce item.
-
quantity:
number
Quantity of the items.
-
rawTotalPrice:
number
The raw total price.
-
returnedQuantity:
number
Quantity for which return request has been raised.
-
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
-
siteId:
string
The ID of the site on which the item was added.
-
skuProperties:
array skuProperties
Sku properties Information
-
stateDetailsAsUser:
string
State description of the commerce item.
-
status:
integer
State of the commerce item.
-
subTotal:
number
The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.
-
tax:
number
The amount of tax paid for this item.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
-
unitPrice:
number
Sale price or list price of commerceItem.
-
variant:
array variant
Product Variant Information.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw total price.",
"type":"number"
},
"returnedQuantity":{
"description":"Quantity for which return request has been raised.",
"type":"number"
},
"displayName":{
"description":"Display name of commerce item.",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"imageInfo":{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
},
"childItems":{
"description":"Child items of the commerce item",
"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"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"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"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child 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"
},
"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 sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
}
}
}
},
"subTotal":{
"description":"The base price for the item, before any modifications. Calculated by multiplying the quantity by the listPrice.",
"type":"number"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"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"
},
"commerceItemId":{
"description":"Commerce Item id of the configurable product",
"type":"string"
},
"price":{
"description":"The raw number that represents the price.",
"type":"number"
},
"variant":{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
},
"onSale":{
"description":"Indicates if product is on Sale or not.",
"type":"boolean"
},
"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"
},
"stateDetailsAsUser":{
"description":"State description of the commerce item.",
"type":"string"
},
"unitPrice":{
"description":"Sale price or list price of commerceItem.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the items.",
"type":"number"
},
"productId":{
"description":"Product Id of commerce item.",
"type":"string"
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"repositoryId":{
"description":"The repository id",
"type":"string"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"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"
},
"tax":{
"description":"The amount of tax paid for this item.",
"type":"number"
},
"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"
},
"catRefId":{
"description":"Catalog Reference Id of commerce item.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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"
},
"status":{
"description":"State of the commerce item.",
"type":"integer"
}
}
}
Nested Schema : childItems
Type:
array
Child items of the commerce item
Show Source
{
"description":"Child items of the commerce item",
"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"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"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"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child 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"
},
"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 sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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 : discountInfo
Type:
object
Discount information.
Show Source
-
orderCouponsMap:
object orderCouponsMap
The coupons that were claimed.
-
orderDiscount:
number
Discount given on an order.
-
orderImplicitDiscountList:
array orderImplicitDiscountList
List of discounts.
-
unclaimedCouponsMap:
array unclaimedCouponsMap
Map of unclaimed coupons.
{
"description":"Discount information.",
"type":"object",
"properties":{
"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"
},
"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"
}
}
}
}
}
}
Nested Schema : externalData
Type:
array
External 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"
}
}
},
"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"
}
}
}
}
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type:
array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"repositoryId":{
"description":"The repository id",
"type":"string"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
}
Nested Schema : imageInfo
Type:
object
Shipping method information.
Show Source
-
primaryThumbImageURL:
string
ThumbNail Image URL
{
"description":"Shipping method information.",
"type":"object",
"properties":{
"primaryThumbImageURL":{
"description":"ThumbNail Image URL",
"type":"string"
}
}
}
Nested Schema : shopperInput
Type:
object
Additional 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 : skuProperties
Type:
array
Sku properties Information
Show Source
{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
}
Nested Schema : variant
Type:
array
Product Variant Information.
Show Source
{
"description":"Product Variant Information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"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.
-
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.
-
catRefId:
string
Sku Id of the child item
-
childItems:
array childItems
Child items of the commerce item
-
commerceItemId:
string
commerce item id of the child item
-
configurablePropertyId:
string
ID of the catalog's configurableProperty associated with this sub commerce item.
-
configurationOptionId:
string
ID of the catalog's configurationOption associated with this sub commerce item.
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
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
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Image route
-
selectedOptions:
array selectedOptions
The array of variants of the child item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
shopperInput:
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId:
string
The ID of the site on which the item was added.
-
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"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
},
"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"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"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"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child 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"
},
"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 sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"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 : childItems
Type:
array
Child items of the commerce item
Show Source
{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
}
Nested Schema : externalData
Type:
array
External 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"
}
}
},
"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"
}
}
}
}
Nested Schema : selectedOptions
Type:
array
The array of variants of the child item.
Show Source
{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
}
Nested Schema : shopperInput
Type:
object
Additional 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.
-
asset:
boolean
The flag that determines if the current item is an asset or not.
-
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.
-
catRefId:
string
Sku Id of the child item
-
customerAccountId:
string
The customer account ID associated to the current item.
-
deactivationDate:
string
The deactivation date in ISO format.
-
displayName:
string
Display name of the child product
-
externalData:
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
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
Product Id of the child item
-
quantity:
number
Quantity of the child item
-
rootAssetKey:
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
route:
string
Image route
-
selectedOptions:
array selectedOptions
The array of variants of the child item.
-
serviceAccountId:
string
The service account ID associated to the current item.
-
serviceId:
string
The service ID associated to the current item.
-
siteId:
string
The ID of the site on which the item was added.
-
transactionDate:
string
ISO formatted Date on which the service action should be triggered.
{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"displayName":{
"description":"Display name of the child product",
"type":"string"
},
"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"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"catRefId":{
"description":"Sku Id of the child 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"
},
"route":{
"description":"Image route",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"selectedOptions":{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
}
}
Nested Schema : externalData
Type:
array
External 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"
}
}
},
"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"
}
}
}
}
Nested Schema : selectedOptions
Type:
array
The array of variants of the child item.
Show Source
{
"description":"The array of variants of the child item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
}
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
{
"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"
}
}
},
"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"
}
}
}
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"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"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
The varian option name.
-
optionValue:
string
The variant option value
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
{
"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"
}
}
},
"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"
}
}
}
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"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"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
The varian option name.
-
optionValue:
string
The variant option value
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value",
"type":"string"
},
"optionName":{
"description":"The varian option name.",
"type":"string"
}
}
}
Nested Schema : orderCouponsMap
Type:
object
The 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:
array
List 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 : unclaimedCouponsMap
Type:
array
Map 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:
object
Coupon 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 : 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:
array
The 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
-
actionCode:
string
The action code that has been set on the externalData item by the configurator system.
-
name:
string
The name to be associated with the externalData item.
-
values:
object values
The array of values associated with an externalData item.
{
"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"
}
}
},
"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"
}
}
}
Nested Schema : values
Type:
object
The array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"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"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
automaticQuantity:
number
The quantity of the free gift that this commerce item is making free and was auto added by pricing.
-
data:
integer
The gift hash code for this GWP promotion.
-
key:
string
atg.gwp
-
remainingQuantity:
number
The quantity of the commerce item that is not affected by GWP.
-
repositoryId:
string
The repository id
-
selectedQuantity:
number
The quantity of the free gift that this commerce item is making free and was selected by the shopper.
-
targetedQuantity:
number
The quantity of the free gift that this commerce item is making free and was targeted by pricing.
-
value:
string
The GWP promotion id.
{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by GWP.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this GWP promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"repositoryId":{
"description":"The repository id",
"type":"string"
},
"value":{
"description":"The GWP promotion id.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
id:
string
ID of the Dynamic SKU Property.
-
name:
string
Name of the Dynamic SKU Property.
-
propertyType:
string
Type that indicates whether it is a base or a custom SKU property,
-
value:
string
Value of the Dynamic SKU Property.
{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
Nested Schema : items
Type:
Show Source
object
-
optionName:
string
Name of the Dynamic attribute.
-
optionValue:
string
Value of the Dynamic attribute.
{
"type":"object",
"properties":{
"optionValue":{
"description":"Value of the Dynamic attribute.",
"type":"string"
},
"optionName":{
"description":"Name of the Dynamic attribute.",
"type":"string"
}
}
}
Example Response (application/json)
{
"shippingGroups":[
{
"taxPriceInfo":{
"cityTax":"3.49",
"amount":"9.96",
"valueAddedTax":"0",
"countyTax":"2.49",
"isTaxIncluded":false,
"miscTax":"0",
"districtTax":"0",
"stateTax":"3.98",
"countryTax":"0"
},
"shippingMethod":{
"shippingTax":"1.05",
"cost":"10.5",
"externalId":null,
"value":"twoDay",
"shippingMethodDescription":"Two Days"
},
"shippingGroupId":"sg10047",
"submittedDate":null,
"priceInfo":{
"amount":"89",
"total":"109.46",
"shipping":"10.5",
"shippingSurchargeValue":"0",
"tax":"9.96",
"subTotal":"89",
"currencyCode":"USD",
"totalWithoutTax":"99.5"
},
"recurringChargePriceInfo":{
"amount":"30",
"total":"32.4",
"shipping":"0",
"subTotalByFrequency":[
{
"amount":"30",
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":"2.4",
"frequency":"Monthly"
}
],
"tax":"2.4",
"subTotal":"30",
"currencyCode":"USD",
"totalWithoutTax":"30"
},
"discountInfo":{
"orderDiscount":"0",
"shippingDiscount":"0",
"discountDescList":[
]
},
"shipOnDate":null,
"trackingInfo":[
],
"actualShipDate":null,
"shippingAddress":{
"lastName":"h",
"country":"US",
"address3":"",
"address2":"A2",
"city":"C1",
"address1":"A1",
"prefix":"",
"companyName":"",
"postalCode":"36123",
"jobTitle":"",
"county":"",
"suffix":"",
"firstName":"h",
"phoneNumber":"34534533",
"alias":"Address##1",
"faxNumber":"",
"middleName":"",
"state":"AL",
"email":"h@example.com"
},
"trackingNumber":null,
"items":[
{
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_AviatorSunglasses_full.jpg&height=100&width=100",
"deactivationDate":"2018-06-27T12:59:59Z",
"rawTotalPrice":"89",
"returnedQuantity":"0",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"displayName":"Aviator Sunglasses",
"shippingSurchargeValue":"0",
"discountAmount":"0",
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"commerceItemId":"ci3000411",
"price":"89",
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"onSale":false,
"primaryImageAltText":"Aviator Sunglasses",
"actionCode":"Add",
"serviceId":"service-123",
"stateDetailsAsUser":"The item has been initialized within the shipping group",
"serviceAccountId":"serviceAcc-123",
"unitPrice":"89",
"primaryImageTitle":"Aviator Sunglasses",
"quantity":"1",
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"productId":"prod20006",
"salePrice":"0",
"detailedItemPriceInfo":[
{
"discounted":false,
"amount":"89",
"quantity":"1",
"tax":"8.91",
"orderDiscountShare":"0",
"detailedUnitPrice":"89",
"currencyCode":"USD"
}
],
"externalRecurringCharge":"10",
"parentAssetKey":null,
"active":true,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40105",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"customerAccountId":"customerAcc-123",
"discountInfo":[
],
"route":"/aviator-sunglasses/product/prod20006",
"siteId":"siteUS",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":"10",
"quantity":"1",
"tax":"0",
"orderDiscountShare":"0",
"detailedUnitPrice":"10",
"currencyCode":"USD"
}
],
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"listPrice":"89",
"recurringCharge":"10",
"status":"INITIAL"
}
],
"email":"a@example.com",
"status":"INITIAL"
}
],
"creationTime":"1419259052037",
"sourceSystem":"Cloud Commerce",
"dynamicProperties":[
{
"id":"dynamicPropertyShippingInstructions",
"label":"Shipping Instructions",
"value":"Test Instructions"
}
],
"approvalSystemMessages":[
"Order is pending approval because total is greater than the approved order limit."
],
"shippingMethod":{
"cost":"10.5",
"value":"twoDay"
},
"payments":[
{
"paymentGroupId":"pg70442",
"amount":"109.46",
"gatewayName":"chaseCreditCard",
"uiIntervention":null,
"paymentMethod":"creditCard",
"isAmountRemaining":true,
"paymentState":"AUTHORIZED"
}
],
"cartName":"Test Name",
"creationDate":"2014-12-22T14:37:32.037Z",
"orderProfileId":"110484",
"uuid":"09e8eb24-734d-4cda-b3b5-b57edd178c75",
"orderAction":"order",
"priceInfo":{
"amount":"89",
"total":"109.46",
"shipping":"10.5",
"shippingSurchargeValue":"20",
"tax":"9.96",
"subTotal":"89",
"currencyCode":"USD"
},
"recurringChargePriceInfo":{
"amount":"30",
"total":"32.4",
"shipping":"0",
"subTotalByFrequency":[
{
"amount":"30",
"frequency":"Monthly"
}
],
"taxByFrequency":[
{
"amount":"2.4",
"frequency":"Monthly"
}
],
"tax":"2.4",
"subTotal":"30",
"currencyCode":"USD",
"totalWithoutTax":"30"
},
"discountInfo":{
"orderDiscount":"0",
"orderDiscountDescList":[
{
"promotionLevel":"item",
"coupon":"FREETATTOO",
"totalAdjustment":"-21.99",
"promotionDesc":"Explicit Item Discount - FREETATTOO",
"promotionId":"explicitItemFreeDiscount"
}
],
"shippingDiscount":"0"
},
"pricingMessages":{
"giftWithPurchaseMessages":[
{
"summary":"The cart has qualified for a free gift promotion.",
"identifier":"GWPQualified",
"params":"[]",
"type":"information",
"priority":"-10"
}
]
},
"trackingInfo":[
],
"shoppingCart":{
"items":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"dynamicProperties":[
{
"id":"dynamicPropertyMode",
"label":"Mode",
"value":"pickup"
}
],
"externalData":[
],
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"assetKey":"12345",
"itemDiscountInfos":[
{
"couponCodes":[
"TestCouponCode"
],
"amount":"10",
"promotionId":"promo10001"
}
],
"commerceItemId":"ci3000411",
"price":"89",
"variant":[
{
"optionValue":"Blue",
"optionName":"Color"
},
{
"optionValue":"Medium",
"optionName":"Size"
}
],
"serviceId":"service-123",
"unitPrice":"89",
"serviceAccountId":"serviceAcc-123",
"quantity":"1",
"productId":"prod20006",
"externalRecurringCharge":"10",
"orderDiscountInfos":[
{
"couponCodes":[
],
"amount":"29.9",
"promotionId":"orderDiscount"
},
{
"couponCodes":[
"coupon101"
],
"amount":"5",
"promotionId":"promo10001"
}
],
"giftWithPurchaseCommerceItemMarkers":[
],
"parentAssetKey":null,
"originalCommerceItemId":null,
"rootAssetKey":null,
"externalRecurringChargeFrequency":"Monthly",
"transactionDate":"2018-06-27T12:59:59Z",
"externalRecurringChargeDuration":"12",
"catRefId":"sku40105",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"UPC Code",
"id":"upcCode",
"value":"123456"
}
],
"discountInfo":[
],
"customerAccountId":"customerAcc-123",
"detailedRecurringChargeInfo":[
{
"discounted":false,
"amount":"10",
"quantity":"1",
"tax":"0",
"orderDiscountShare":"0",
"detailedUnitPrice":"10",
"currencyCode":"USD"
}
],
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"recurringCharge":"10"
}
]
},
"shippingAddress":{
"lastName":"h",
"country":"US",
"address3":null,
"address2":"A2",
"city":"C1",
"address1":"A1",
"prefix":null,
"companyName":null,
"postalCode":"36123",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"h",
"phoneNumber":"34534533",
"faxNumber":null,
"alias":null,
"middleName":null,
"state":"AL",
"email":"h@example.com"
},
"id":"o10003",
"quoteInfo":{
"providerNote":null,
"notes":[
{
"profileType":null,
"profileId":"120213",
"requestDate":"1477479521002",
"requesterNote":"This is a sample quote"
}
],
"rejectionDate":null,
"requestDate":"2016-10-26T10:58:41.002Z",
"errorInfo":null,
"externalID":null,
"quoteSubmitted":false,
"rejectionNote":null,
"quoteDate":null,
"expirationDate":null
},
"markers":[
],
"giftWithPurchaseOrderMarkers":[
{
"quantity":"1",
"selectedQuantity":"0",
"removedQuantity":"0",
"data":"-1275480226",
"automaticQuantity":"0",
"giftType":"product",
"autoRemove":true,
"giftDetail":"camera_1",
"repositoryId":"200001",
"failedQuantity":"0",
"value":"promo10002",
"targetedQuantity":"0",
"key":"atg.gwp"
}
]
}
Default Response
In case of any failure in external tax or external shipping webhooks, the errors returned in the webhook response payload get added to the errors property in this endpoint???s error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
28080 | Empty shopping cart data. | The current order does not contain any shopping cart data you must add it in first before updating anything else. |
28102 | No product found matching the provided product ID. | Ensure the product ID entered is valid and that it exists. |
28129 | Sku was not found for the entered product ID. | Ensure the provided sku is linked to the product ID provided. |
28089 | Empty shipping address data. | Please provide valid shipping address data. |
28087 | No shipping method was specified. | Please provide valid shipping method. |
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:
array
An 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"
}
}
}