- REST API for Oracle Commerce Cloud 21D
- Tasks
- Agent
- Orders
post
/ccagent/v1/orders/initiateCancelOrder
Initiate Cancel.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCAgentContext.shopperProfileId: string
the profile id from which the order was placed
-
X-CCOrganization(optional): string
the organization Id in which order should be created
-
x-ccsite: string
the site id on which the orders needs to be placed
Body ()
Root Schema : initiateCancelOrder_request
Type:
Show Source
object-
cancelReason:
string
The reason for cancelling the order
-
orderId:
string
The ID of the order that is to be cancelled
{
"properties":{
"orderId":{
"description":"The ID of the order that is to be cancelled",
"type":"string"
},
"cancelReason":{
"description":"The reason for cancelling the order",
"type":"string"
}
},
"required":[
"orderId",
"cancelReason"
],
"example":{
"orderId":"o30411",
"cancelReason":"betterCompetitorPrice"
}
}Example:
{
"orderId":"o30411",
"cancelReason":"betterCompetitorPrice"
}Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body ()
Root Schema : initiateCancelOrder_response
Type:
Show Source
object-
cancelOrder(optional):
object cancelOrder
Initiate Cancel information for the order.
-
returnRequest(optional):
object returnRequest
return request created for for the cancel order.
{
"properties":{
"cancelOrder":{
"description":"Initiate Cancel information for the order.",
"type":"object",
"properties":{
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"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":"Billing address for the order",
"type":"object",
"properties":{
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"lastName":{
"description":"Last Name 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"
},
"jobTitle":{
"description":"JOb Title for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Default value of the address.",
"type":"boolean"
},
"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"
},
"repositoryId":{
"description":"Repository ID of the address.",
"type":"string"
},
"faxNumber":{
"description":"Fax Number for this billing address.",
"type":"string"
},
"alias":{
"description":"Nickname or alternate name for address like home/office.",
"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 ISON code of the shipping address.",
"type":"string"
}
},
"required":[
"firstName",
"lastName",
"postalCode",
"address1",
"city",
"selectedCountry",
"selectedState"
]
},
"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"
},
"payTaxInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax 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"
},
"organizationId":{
"description":"The organization ID.",
"type":"string"
},
"priceInfo":{
"description":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"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"
},
"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"
},
"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"
]
}
},
"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 assigned only 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"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"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"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring 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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"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"
},
"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":{
"description":"Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.",
"type":"array",
"items":{
"type":"object",
"properties":{
"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"
}
}
},
"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"
}
}
},
"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":{
"description":"The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.",
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
},
"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"
}
},
"shippingGroupClassType":{
"description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
"type":"string"
}
}
}
},
"taxExempt":{
"description":"Whether order is tax-exempt or not.",
"type":"boolean"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"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"
},
"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"
},
"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"
},
"email":{
"description":"The email address",
"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"
},
"shippingGroupCount":{
"description":"The number of shipping groups (read-only, value is ignored when updating).",
"type":"integer"
},
"paymentGroupCount":{
"description":"The number of payment groups. (read-only, value is ignored when updating)",
"type":"integer"
},
"orderAction":{
"description":"The action performed on the order.",
"type":"string"
},
"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"
}
}
},
"returnRequest":{
"description":"return request created for for the cancel order.",
"type":"object",
"properties":{
"agentId":{
"description":"Agent ID",
"type":"string"
},
"shippingTaxRefund":{
"description":"Shipping Tax Refund at return request level",
"type":"number"
},
"authorizationDate":{
"description":"Creation Date of return request",
"type":"string"
},
"refundSubtotal":{
"description":"Refund subtotal return request",
"type":"number"
},
"refundMethodList":{
"description":"List of Refund methods of return request",
"type":"array",
"items":{
"type":"object",
"properties":{
"refundType":{
"description":"Type of the refund. For example this can be creditCard, tokenizedCreditCard\tetc",
"type":"string"
},
"amount":{
"description":"The amount pertaining to the refund method",
"type":"number"
},
"maxRefundAmount":{
"description":"The maximum amount that can be refunded from the refund method",
"type":"number"
}
}
}
},
"suggestedShippingRefund":{
"description":"Suggested Shipping Refund of all Return Items",
"type":"number"
},
"originatingOrder":{
"description":"Original order information",
"type":"object",
"properties":{
"approverIds":{
"description":"List of ids of approvers",
"type":"array",
"items":{
"type":"string"
}
},
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"if tax is included in the price",
"type":"boolean"
},
"miscTax":{
"description":"miscellaneous tax",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
}
}
},
"gwp":{
"description":"",
"type":"boolean"
},
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"type":"string"
},
"shippingGroups":{
"description":"The shipping groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The current total tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"shippingMethod":{
"description":"Shipping method",
"type":"string"
}
}
}
},
"lastModifiedTime":{
"description":"Time at which order was last modified",
"type":"number"
},
"priceGroupId":{
"description":"Price list group ID",
"type":"string"
},
"creationTime":{
"description":"Creation tinme for order",
"type":"number"
},
"sourceSystem":{
"description":"The system where the order originated.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the order was submitted.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
},
"paymentGroups":{
"description":"List of payment Groups for the order. Related Endpoint operations - submitOrder",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"ID of this payment Group.",
"type":"integer"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"state":{
"description":"The payment state, it can be INCOMPLETE or COMPLETE ",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
}
}
}
},
"payShippingInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay shipping charges in monetary currency. Additionally, 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"
},
"configuratorId":{
"description":"Configuration ID of the configurable product",
"type":"string"
},
"payTaxInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, 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":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"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":"total number of commerce items in order",
"type":"number"
},
"id":{
"description":"order ID",
"type":"string"
},
"state":{
"description":"The state of the order",
"type":"string"
},
"commerceItems":{
"description":"list of commerce items",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
}
}
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name",
"type":"string"
},
"id":{
"description":"commerce item ID",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
}
}
}
}
}
},
"returnPaymentState":{
"description":"Return Payment State. It can be Refund, None or Due",
"type":"string"
},
"orderCurrencyCode":{
"description":"The currency code of the order currency",
"type":"string"
},
"state":{
"description":"State of the return request like PENDING_CUSTOMER_ACTION etc",
"type":"string"
},
"unAdjustedRefundSubtotal":{
"description":"Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items",
"type":"number"
},
"trackingNumber":{
"description":"List of tracking numbers for the return request",
"type":"array",
"items":{
"type":"string"
}
},
"returnItemCount":{
"description":"Count of all the return items in the return request",
"type":"number"
},
"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"
},
"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"
},
"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"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"repositoryId":{
"description":"ID.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"login":{
"description":"Login ID to be used.Defaults for email if not passed.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
},
"suggestedTaxRefund":{
"description":"Suggested Tax Refund at return request level",
"type":"number"
},
"actualShippingRefund":{
"description":"Actual Shipping Refund at return request level",
"type":"number"
},
"otherRefund":{
"description":"Other refund",
"type":"number"
},
"actualTaxRefund":{
"description":"actual Tax Refund",
"type":"number"
},
"returnLabel":{
"description":"Return Label",
"type":"string"
},
"returnFee":{
"description":"Return Fee for the return request",
"type":"number"
},
"additionalProperties":{
"description":"Map of Additional properties for return request",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
},
"totalRefundAmount":{
"description":"Total refund amount",
"type":"number"
},
"unallocatedAmount":{
"description":"The total refund amount that is not allocated to a refund method",
"type":"number"
},
"returnItemList":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity returned",
"type":"number"
},
"quantityAvailable":{
"description":"Quantity Available",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"secondaryCurrencyActualTaxRefundShare":{
"description":"Actual Tax refund at return item level in secondary currency",
"type":"number"
},
"returnItemId":{
"description":"ID of the return Item",
"type":"string"
},
"shippingGroupId":{
"description":"Shipping group ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingSurchargeRefundShare":{
"description":"Actual shipping surcharge refund at return item level in secondary currency",
"type":"number"
},
"catalogRefId":{
"description":"The reference ID of the catalog this return item references. Typically the SKU ID.",
"type":"string"
},
"quantityWithFractionReceived":{
"description":"Quantity recieved in fraction",
"type":"number"
},
"suggestedShippingRefundShare":{
"description":"Suggested Shipping Refund",
"type":"number"
},
"commerceItemId":{
"description":"Commerce ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingRefundShare":{
"description":"Actual shipping refund at return item level in secondary currency",
"type":"number"
},
"disposition":{
"description":"Disposition reason",
"type":"string"
},
"quantityShipped":{
"description":"Quantity of this item that was originally shipped",
"type":"number"
},
"actualShippingSurchargeRefundShare":{
"description":"Actual Shipping Surcharge Refund at Item level",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"actualShippingRefundShare":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"additionalProperties":{
"description":"Map of Additional properties for each return item",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
},
"state":{
"description":"state at return item level",
"type":"string"
},
"suggestedRefundAmount":{
"description":"Suggested Refund Amount Item level",
"type":"number"
},
"actualTaxRefundShare":{
"description":"Actual Tax Refund at Item level",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"string"
},
"refundAmount":{
"description":"Refund Amount at Item level",
"type":"number"
}
}
}
},
"adjustmentAmount":{
"description":"Adjustment Amount",
"type":"number"
}
}
}
},
"example":{
"priceGroupId":"defaultPriceGroup",
"lastModifiedTime":1.409947606E12,
"creationTime":1.409947604E12,
"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,
"currencyCode":"USD"
},
"totalCommerceItemCount":3,
"state":"SUBMITTED",
"id":"o10076",
"commerceItems":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"preOrderQuantity":0,
"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,
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"externalPriceDetails":{
"externalPriceQuantity":1,
"externalPrice":100
},
"actionCode":"Add",
"id":"ci1000076",
"serviceId":"service-123",
"commerceItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"addOnItem":false,
"quantity":1,
"productId":"prod40001",
"externalData":[
],
"parentAssetKey":null,
"billingAccountId":"billingAcc-123",
"originalCommerceItemId":"o30417",
"rootAssetKey":null,
"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
},
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"siteId":"siteUS",
"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,
"billingAccountId":"billingAcc-123",
"originalCommerceItemId":"o30417",
"rootAssetKey":null,
"configurablePropertyId":"product10222",
"catalogRefId":"sku40005",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"siteId":"siteUS",
"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":"o30417",
"rootAssetKey":null,
"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",
"siteId":"siteUS",
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"backOrderQuantity":0
}
],
"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":[
{
"shippingMethod":"freeShippingMethod",
"description":"sg10076",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":1.5,
"amount":0,
"secondaryCurrencyShippingAmount":6,
"rawShipping":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"trackingInfo":[
{
"carrierName":"USPS",
"trackingUrl":"https://tools.usps.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":[
{
"commerceItemId":"ci1000076",
"amount":0,
"quantity":3,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"commerceItemExternalId":null,
"id":"r10066"
}
],
"state":"INITIAL",
"id":"sg10076",
"stateDetail":null,
"trackingNumber":"USPS-ABC123",
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"creationSiteId":"siteUS",
"profile":{
"lastName":"FLORES",
"firstName":"FLORENCE",
"shippingAddress":{
"country":"US",
"phoneNumber":null,
"address3":null,
"address2":null,
"city":"Branford",
"address1":"203 Main Street",
"postalCode":"32008",
"county":null,
"state":null
},
"middleName":null,
"email":"FLORENCE.FLORES@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"
}
}Example:
{
"priceGroupId":"defaultPriceGroup",
"lastModifiedTime":1.409947606E12,
"creationTime":1.409947604E12,
"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,
"currencyCode":"USD"
},
"totalCommerceItemCount":3,
"state":"SUBMITTED",
"id":"o10076",
"commerceItems":[
{
"deactivationDate":"2018-06-27T12:59:59Z",
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":"billingAcc-123",
"preOrderQuantity":0,
"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,
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"externalPriceDetails":{
"externalPriceQuantity":1,
"externalPrice":100
},
"actionCode":"Add",
"id":"ci1000076",
"serviceId":"service-123",
"commerceItems":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"addOnItem":false,
"quantity":1,
"productId":"prod40001",
"externalData":[
],
"parentAssetKey":null,
"billingAccountId":"billingAcc-123",
"originalCommerceItemId":"o30417",
"rootAssetKey":null,
"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
},
"externalRecurringChargeDetails":{
"externalRecurringCharge":10,
"externalRecurringChargeFrequency":"Monthly",
"externalRecurringChargeDuration":"12"
},
"siteId":"siteUS",
"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,
"billingAccountId":"billingAcc-123",
"originalCommerceItemId":"o30417",
"rootAssetKey":null,
"configurablePropertyId":"product10222",
"catalogRefId":"sku40005",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"siteId":"siteUS",
"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":"o30417",
"rootAssetKey":null,
"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",
"siteId":"siteUS",
"shopperInput":{
"color":"neon",
"initials":"M.C.K",
"font":"courier"
},
"activationDate":"2017-06-27T15:30:00Z",
"asset":false,
"backOrderQuantity":0
}
],
"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":[
{
"shippingMethod":"freeShippingMethod",
"description":"sg10076",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":1.5,
"amount":0,
"secondaryCurrencyShippingAmount":6,
"rawShipping":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"trackingInfo":[
{
"carrierName":"USPS",
"trackingUrl":"https://tools.usps.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":[
{
"commerceItemId":"ci1000076",
"amount":0,
"quantity":3,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"commerceItemExternalId":null,
"id":"r10066"
}
],
"state":"INITIAL",
"id":"sg10076",
"stateDetail":null,
"trackingNumber":"USPS-ABC123",
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"creationSiteId":"siteUS",
"profile":{
"lastName":"FLORES",
"firstName":"FLORENCE",
"shippingAddress":{
"country":"US",
"phoneNumber":null,
"address3":null,
"address2":null,
"city":"Branford",
"address1":"203 Main Street",
"postalCode":"32008",
"county":null,
"state":null
},
"middleName":null,
"email":"FLORENCE.FLORES@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"
}Nested Schema : cancelOrder
Type:
objectInitiate Cancel information for the order.
Show Source
-
allowAlternateCurrency(optional):
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.
-
commerceItems(optional):
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(optional):
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(optional):
integer
The creation time.
-
exchangeRate(optional):
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(optional):
string
The ID
-
lastModifiedTime(optional):
integer
The last modified time.
-
locale(optional):
string
The locale in which order submitted.
-
orderAction(optional):
string
The action performed on the order.
-
organizationId(optional):
string
The organization ID.
-
paymentGroupCount(optional):
integer
The number of payment groups. (read-only, value is ignored when updating)
-
paymentGroups(optional):
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.
-
payShippingInSecondaryCurrency(optional):
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(optional):
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay tax 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..
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
priceGroupId(optional):
string
The ID of the price group to which the order belongs.
-
priceInfo(optional):
object priceInfo
The order price information.
-
profile(optional):
object profile
Basic profile information. (read-only)
-
profileId(optional):
string
The ID of the shopper profile that owns the order.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information of the order
-
salesChannel(optional):
string
The sales channel of this order. default to "default".
-
secondaryCurrencyCode(optional):
string
The currency code of secondary currency associated with the site.
-
shippingGroupCount(optional):
integer
The number of shipping groups (read-only, value is ignored when updating).
-
shippingGroups(optional):
array shippingGroups
Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.
-
siteId(optional):
string
The ID of the site on which the order was placed.
-
sourceSystem(optional):
string
The system where the order originated.
-
state(optional):
string
The state of the order.
-
taxExempt(optional):
boolean
Whether order is tax-exempt or not.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
totalCommerceItemCount(optional):
integer
The total count of commerce items in the order. (read-only)
{
"description":"Initiate Cancel information for the order.",
"type":"object",
"properties":{
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"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":"Billing address for the order",
"type":"object",
"properties":{
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"lastName":{
"description":"Last Name 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"
},
"jobTitle":{
"description":"JOb Title for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Default value of the address.",
"type":"boolean"
},
"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"
},
"repositoryId":{
"description":"Repository ID of the address.",
"type":"string"
},
"faxNumber":{
"description":"Fax Number for this billing address.",
"type":"string"
},
"alias":{
"description":"Nickname or alternate name for address like home/office.",
"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 ISON code of the shipping address.",
"type":"string"
}
},
"required":[
"firstName",
"lastName",
"postalCode",
"address1",
"city",
"selectedCountry",
"selectedState"
]
},
"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"
},
"payTaxInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax 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"
},
"organizationId":{
"description":"The organization ID.",
"type":"string"
},
"priceInfo":{
"description":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"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"
},
"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"
},
"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"
]
}
},
"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 assigned only 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"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"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"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring 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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"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"
},
"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":{
"description":"Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.",
"type":"array",
"items":{
"type":"object",
"properties":{
"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"
}
}
},
"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"
}
}
},
"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":{
"description":"The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.",
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
},
"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"
}
},
"shippingGroupClassType":{
"description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
"type":"string"
}
}
}
},
"taxExempt":{
"description":"Whether order is tax-exempt or not.",
"type":"boolean"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"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"
},
"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"
},
"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"
},
"email":{
"description":"The email address",
"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"
},
"shippingGroupCount":{
"description":"The number of shipping groups (read-only, value is ignored when updating).",
"type":"integer"
},
"paymentGroupCount":{
"description":"The number of payment groups. (read-only, value is ignored when updating)",
"type":"integer"
},
"orderAction":{
"description":"The action performed on the order.",
"type":"string"
},
"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"
}
}
}Nested Schema : returnRequest
Type:
objectreturn request created for for the cancel order.
Show Source
-
actualShippingRefund(optional):
number
Actual Shipping Refund at return request level
-
actualTaxRefund(optional):
number
actual Tax Refund
-
additionalProperties(optional):
object additionalProperties
Map of Additional properties for return request
-
adjustmentAmount(optional):
number
Adjustment Amount
-
agentId(optional):
string
Agent ID
-
authorizationDate(optional):
string
Creation Date of return request
-
orderCurrencyCode(optional):
string
The currency code of the order currency
-
originatingOrder(optional):
object originatingOrder
Original order information
-
otherRefund(optional):
number
Other refund
-
profile(optional):
object profile
Profile Information for the order.
-
refundMethodList(optional):
array refundMethodList
List of Refund methods of return request
-
refundSubtotal(optional):
number
Refund subtotal return request
-
returnFee(optional):
number
Return Fee for the return request
-
returnItemCount(optional):
number
Count of all the return items in the return request
-
returnItemList(optional):
array returnItemList
List of returnable Items
-
returnLabel(optional):
string
Return Label
-
returnPaymentState(optional):
string
Return Payment State. It can be Refund, None or Due
-
shippingTaxRefund(optional):
number
Shipping Tax Refund at return request level
-
state(optional):
string
State of the return request like PENDING_CUSTOMER_ACTION etc
-
suggestedShippingRefund(optional):
number
Suggested Shipping Refund of all Return Items
-
suggestedTaxRefund(optional):
number
Suggested Tax Refund at return request level
-
totalRefundAmount(optional):
number
Total refund amount
-
trackingNumber(optional):
array trackingNumber
List of tracking numbers for the return request
-
unAdjustedRefundSubtotal(optional):
number
Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items
-
unallocatedAmount(optional):
number
The total refund amount that is not allocated to a refund method
{
"description":"return request created for for the cancel order.",
"type":"object",
"properties":{
"agentId":{
"description":"Agent ID",
"type":"string"
},
"shippingTaxRefund":{
"description":"Shipping Tax Refund at return request level",
"type":"number"
},
"authorizationDate":{
"description":"Creation Date of return request",
"type":"string"
},
"refundSubtotal":{
"description":"Refund subtotal return request",
"type":"number"
},
"refundMethodList":{
"description":"List of Refund methods of return request",
"type":"array",
"items":{
"type":"object",
"properties":{
"refundType":{
"description":"Type of the refund. For example this can be creditCard, tokenizedCreditCard\tetc",
"type":"string"
},
"amount":{
"description":"The amount pertaining to the refund method",
"type":"number"
},
"maxRefundAmount":{
"description":"The maximum amount that can be refunded from the refund method",
"type":"number"
}
}
}
},
"suggestedShippingRefund":{
"description":"Suggested Shipping Refund of all Return Items",
"type":"number"
},
"originatingOrder":{
"description":"Original order information",
"type":"object",
"properties":{
"approverIds":{
"description":"List of ids of approvers",
"type":"array",
"items":{
"type":"string"
}
},
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"if tax is included in the price",
"type":"boolean"
},
"miscTax":{
"description":"miscellaneous tax",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
}
}
},
"gwp":{
"description":"",
"type":"boolean"
},
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"type":"string"
},
"shippingGroups":{
"description":"The shipping groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The current total tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"shippingMethod":{
"description":"Shipping method",
"type":"string"
}
}
}
},
"lastModifiedTime":{
"description":"Time at which order was last modified",
"type":"number"
},
"priceGroupId":{
"description":"Price list group ID",
"type":"string"
},
"creationTime":{
"description":"Creation tinme for order",
"type":"number"
},
"sourceSystem":{
"description":"The system where the order originated.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the order was submitted.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
},
"paymentGroups":{
"description":"List of payment Groups for the order. Related Endpoint operations - submitOrder",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"ID of this payment Group.",
"type":"integer"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"state":{
"description":"The payment state, it can be INCOMPLETE or COMPLETE ",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
}
}
}
},
"payShippingInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay shipping charges in monetary currency. Additionally, 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"
},
"configuratorId":{
"description":"Configuration ID of the configurable product",
"type":"string"
},
"payTaxInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, 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":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"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":"total number of commerce items in order",
"type":"number"
},
"id":{
"description":"order ID",
"type":"string"
},
"state":{
"description":"The state of the order",
"type":"string"
},
"commerceItems":{
"description":"list of commerce items",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
}
}
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name",
"type":"string"
},
"id":{
"description":"commerce item ID",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
}
}
}
}
}
},
"returnPaymentState":{
"description":"Return Payment State. It can be Refund, None or Due",
"type":"string"
},
"orderCurrencyCode":{
"description":"The currency code of the order currency",
"type":"string"
},
"state":{
"description":"State of the return request like PENDING_CUSTOMER_ACTION etc",
"type":"string"
},
"unAdjustedRefundSubtotal":{
"description":"Refund SubTotal calculated as summation of unAdjustedRefundAmount for all return Items",
"type":"number"
},
"trackingNumber":{
"description":"List of tracking numbers for the return request",
"type":"array",
"items":{
"type":"string"
}
},
"returnItemCount":{
"description":"Count of all the return items in the return request",
"type":"number"
},
"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"
},
"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"
},
"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"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"repositoryId":{
"description":"ID.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"login":{
"description":"Login ID to be used.Defaults for email if not passed.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
},
"suggestedTaxRefund":{
"description":"Suggested Tax Refund at return request level",
"type":"number"
},
"actualShippingRefund":{
"description":"Actual Shipping Refund at return request level",
"type":"number"
},
"otherRefund":{
"description":"Other refund",
"type":"number"
},
"actualTaxRefund":{
"description":"actual Tax Refund",
"type":"number"
},
"returnLabel":{
"description":"Return Label",
"type":"string"
},
"returnFee":{
"description":"Return Fee for the return request",
"type":"number"
},
"additionalProperties":{
"description":"Map of Additional properties for return request",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
},
"totalRefundAmount":{
"description":"Total refund amount",
"type":"number"
},
"unallocatedAmount":{
"description":"The total refund amount that is not allocated to a refund method",
"type":"number"
},
"returnItemList":{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity returned",
"type":"number"
},
"quantityAvailable":{
"description":"Quantity Available",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"secondaryCurrencyActualTaxRefundShare":{
"description":"Actual Tax refund at return item level in secondary currency",
"type":"number"
},
"returnItemId":{
"description":"ID of the return Item",
"type":"string"
},
"shippingGroupId":{
"description":"Shipping group ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingSurchargeRefundShare":{
"description":"Actual shipping surcharge refund at return item level in secondary currency",
"type":"number"
},
"catalogRefId":{
"description":"The reference ID of the catalog this return item references. Typically the SKU ID.",
"type":"string"
},
"quantityWithFractionReceived":{
"description":"Quantity recieved in fraction",
"type":"number"
},
"suggestedShippingRefundShare":{
"description":"Suggested Shipping Refund",
"type":"number"
},
"commerceItemId":{
"description":"Commerce ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingRefundShare":{
"description":"Actual shipping refund at return item level in secondary currency",
"type":"number"
},
"disposition":{
"description":"Disposition reason",
"type":"string"
},
"quantityShipped":{
"description":"Quantity of this item that was originally shipped",
"type":"number"
},
"actualShippingSurchargeRefundShare":{
"description":"Actual Shipping Surcharge Refund at Item level",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"actualShippingRefundShare":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"additionalProperties":{
"description":"Map of Additional properties for each return item",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
},
"state":{
"description":"state at return item level",
"type":"string"
},
"suggestedRefundAmount":{
"description":"Suggested Refund Amount Item level",
"type":"number"
},
"actualTaxRefundShare":{
"description":"Actual Tax Refund at Item level",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"string"
},
"refundAmount":{
"description":"Refund Amount at Item level",
"type":"number"
}
}
}
},
"adjustmentAmount":{
"description":"Adjustment Amount",
"type":"number"
}
}
}Nested Schema : commerceItems
Type:
arrayThe commerce items (sometimes referred to as "line items") represent which actual skus are included in the order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.
Show Source
{
"description":"The commerce items (sometimes referred to as \"line items\") represent which actual skus are included in the order in what quantity, and related information. Please see caution in description of update order. Existing commerce items are matched to input data by externalId, followed by id, followed by catalogRefId. The elements in the commerceItem are instances of CommerceItemImpl.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
]
}
},
"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 assigned only 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"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"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"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring 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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"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"
},
"backOrderQuantity":{
"description":"The backordered quantity included.",
"type":"integer"
}
}
}
}Nested Schema : paymentGroups
Type:
arrayThe array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of "tokenizedCreditCard"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of "externalPaymentGroup"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.
Show Source
{
"description":"The array of payment groups represent the payment(s) that paid for the order. Orders when placed will have an instance of a CyberSource TokenizedCreditCard (paymentGroupClassType and paymentMethod of \"tokenizedCreditCard\"). The paymentGroups property can be updated to include instances of ExternalPaymentGroup (paymentGroupClassType and paymentMethod of \"externalPaymentGroup\"). ExternalPaymentGroups represent methods of payment that are external and opaque to cloud commerce, and which were taken after the order was initially placed.",
"type":"array",
"items":{
"type":"object",
"properties":{
"expirationYear":{
"description":"A string containing the two or four digit year when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"PONumber":{
"description":"The purchase order number.",
"type":"string"
},
"amountAuthorized":{
"description":"The monetary amount authorized.",
"type":"number"
},
"externalType":{
"description":"The type in the external system. Might be \"StoreCredit\", \"CreditCard\", \"Check\", etc. (only for ExternalPaymentGroups).",
"type":"string"
},
"amount":{
"description":"The monetary amount of the payment.",
"type":"number"
},
"externalId":{
"description":"The ID for the payment group in an external system (like the OMS)",
"type":"string"
},
"creditCardType":{
"description":"The type of the credit card. (only for TokenizedCreditCards)",
"type":"string"
},
"expirationMonth":{
"description":"A string containing the two digit month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
},
"submittedDate":{
"description":"The date the payment was submitted.",
"type":"string"
},
"authorizationStatus":{
"description":"Array of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
},
"token":{
"description":"The CyberSource token string. (only for tokenizedCreditCard)",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of the credit card.",
"type":"string"
},
"paymentGroupClassType":{
"description":"The class type of the payment group. Currently supported values are \"tokenizedCreditCard\" and \"externalPaymentGroup\".",
"type":"string"
},
"creditCardNumber":{
"description":"The last four digits of the credit card number. (only for TokenizedCreditCards)",
"type":"string"
},
"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":"Billing address for the order",
"type":"object",
"properties":{
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"lastName":{
"description":"Last Name 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"
},
"jobTitle":{
"description":"JOb Title for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Default value of the address.",
"type":"boolean"
},
"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"
},
"repositoryId":{
"description":"Repository ID of the address.",
"type":"string"
},
"faxNumber":{
"description":"Fax Number for this billing address.",
"type":"string"
},
"alias":{
"description":"Nickname or alternate name for address like home/office.",
"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 ISON code of the shipping address.",
"type":"string"
}
},
"required":[
"firstName",
"lastName",
"postalCode",
"address1",
"city",
"selectedCountry",
"selectedState"
]
},
"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:
objectThe order price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
primaryCurrencyTotal(optional):
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(optional):
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(optional):
number
The shipping surcharges added at item level in monetary currency.
-
secondaryCurrencyTaxAmount(optional):
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(optional):
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. -
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
The sub-total amount.
-
tax(optional):
number
The total tax amount.
-
taxExclusiveAmount(optional):
number
Total excluding shipping and tax in monetary currency
-
total(optional):
number
The order total.
{
"description":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}Nested Schema : profile
Type:
objectBasic profile information. (read-only)
Show Source
-
email(optional):
string
The email address
-
firstName(optional):
string
First name.
-
lastName(optional):
string
Last name.
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
middleName(optional):
string
Middle name.
-
shippingAddress(optional):
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"
},
"email":{
"description":"The email address",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information of the order
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
discountAmount(optional):
number
The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
manualAdjustmentTotal(optional):
number
The monetary total of manual adjustments.
-
rawSubtotal(optional):
number
The monetary raw subtotal.
-
shipping(optional):
number
The monetary cost of shipping.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
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:
arrayShipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.
Show Source
{
"description":"Shipping groups represent shipments and include commerceItemRelationships that represent which commerce items in what quantity are included in the shipment. Shipping groups in a request are matched to existing shipping groups by id, followed by description, followed by (for hardgoodShippingGroups) shippingMethod + address.",
"type":"array",
"items":{
"type":"object",
"properties":{
"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"
}
}
},
"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"
}
}
},
"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":{
"description":"The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.",
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
},
"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"
}
},
"shippingGroupClassType":{
"description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
"type":"string"
}
}
}
}Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
cityTax(optional):
number
The monetary amount of city tax.
-
countryTax(optional):
number
The monetary amount of country tax.
-
countyTax(optional):
number
The monetary amount of county tax.
-
currencyCode(optional):
string
The three character currency code.
-
discounted(optional):
boolean
Whether the price was discounted.
-
districtTax(optional):
number
Tax amount for the district.
-
secondaryCurrencyTaxAmount(optional):
number
The tax amount in secondary currency
-
stateTax(optional):
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(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
availabilityDate(optional):
integer
The availabilityDate for preordered/backordered quantity.
-
backOrderQuantity(optional):
integer
The backordered quantity included.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogId(optional):
string
The ID of the catalog which this commerce item references.
-
catalogKey(optional):
string
The key of the catalog this commerce item references.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configuratorId(optional):
string
Configuration ID for the configurable commerce item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalId(optional):
string
An optional, external ID for this commerce item.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about pricing.
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
id(optional):
string
The internal/native ID for this commerce item.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
preOrderQuantity(optional):
integer
The preordered quantity included.
-
priceInfo(optional):
object priceInfo
Details about pricing.
-
productDisplayName(optional):
string
The product's display name. (read-only, obtained from the referenced product)
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
returnedQuantity(optional):
integer
The quantity returned.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
-
state(optional):
string
The state of this commerce item. (read-only, calculated from shippingGroups' commerceItemRelationships)
-
stateDetail(optional):
string
Details about the state of this commerce item.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"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"
]
}
},
"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 assigned only 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"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"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"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring 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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about pricing.
Show Source
-
externalPrice(optional):
number
External price for this commerce item
-
externalPriceQuantity(optional):
integer
External quantity of this commerce item
{
"description":"Details about pricing.",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"External quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price for this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The 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 : priceInfo
Type:
objectDetails about pricing.
Show Source
-
amount(optional):
number
The monetary amount of this order.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price.
-
salePrice(optional):
number
The sale price
-
secondaryShippingSurcharge(optional):
number
Extra handling cost in secondary currency for shipping the product.
-
shippingSurcharge(optional):
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"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"secondaryShippingSurcharge":{
"description":"Extra handling cost in secondary currency for shipping the product.",
"type":"number"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the sub commerce item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"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"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"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"
},
"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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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"
}
}
}
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"parentAssetKey":{
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : 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"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
string
The action code that has been set on the item by the configurator system.
-
activationDate(optional):
string
The activation date in ISO format.
-
addOnItem(optional):
boolean
Whether the child item is an add-on (internally configured) or not (externally configured).
-
asset(optional):
boolean
The flag that determines if the current item is an asset or not.
-
assetKey(optional):
string
The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.
-
billingAccountId(optional):
string
The billing account ID associated to the current item.
-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
commerceItems(optional):
array commerceItems
-
configurablePropertyId(optional):
string
ID of the catalog's configurableProperty associated with this item.
-
configurationOptionId(optional):
string
ID of the catalog's configurationOption associated with this item.
-
customerAccountId(optional):
string
The customer account ID associated to the current item.
-
deactivationDate(optional):
string
The deactivation date in ISO format.
-
externalData(optional):
array externalData
External data to be associated with a commerce item, provided by a configurator system.
-
externalPriceDetails(optional):
object externalPriceDetails
Details about external pricing
-
externalRecurringChargeDetails(optional):
object externalRecurringChargeDetails
Details about external recurring pricing.
-
originalCommerceItemId(optional):
string
The Commerce Item ID associated with the original item from which item in cancel order is created.
-
parentAssetKey(optional):
string
The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
rootAssetKey(optional):
string
The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.
-
serviceAccountId(optional):
string
The service account ID associated to the current item.
-
serviceId(optional):
string
The service ID associated to the current item.
-
shopperInput(optional):
object shopperInput
Additional Properties Allowed: additionalPropertiesMap of shopper input keys to values
-
siteId(optional):
string
The ID of the site on which the item was added.
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"assetKey":{
"description":"The assetKey is assigned only when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeDetails":{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
},
"externalPriceDetails":{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
},
"actionCode":{
"description":"The action code that has been set on 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"
},
"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"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
},
"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 : commerceItems
Type:
Show Source
array{
"type":"array",
"items":{
"properties":{
}
}
}Nested Schema : externalData
Type:
arrayExternal data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}Nested Schema : externalPriceDetails
Type:
objectDetails about external pricing
Show Source
-
externalPrice(optional):
number
External price of this commerce item
-
externalPriceQuantity(optional):
integer
external quantity of this commerce item
{
"description":"Details about external pricing",
"type":"object",
"properties":{
"externalPriceQuantity":{
"description":"external quantity of this commerce item",
"type":"integer"
},
"externalPrice":{
"description":"External price of this commerce item",
"type":"number"
}
}
}Nested Schema : externalRecurringChargeDetails
Type:
objectDetails about external recurring pricing.
Show Source
-
externalRecurringCharge(optional):
number
The external recurring price.
-
externalRecurringChargeDuration(optional):
string
The duration for the recurring charge e.g. 12 months.
-
externalRecurringChargeFrequency(optional):
string
The frequency for the recurring charge e.g. Monthly.
{
"description":"Details about external recurring pricing.",
"type":"object",
"properties":{
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
currentPriceDetailsSorted(optional):
array currentPriceDetailsSorted
The current price details.
-
discountable(optional):
boolean
Whether discountable.
-
discounted(optional):
boolean
Whether the recurring charge price is discounted.
-
listPrice(optional):
number
The monetary amount of the list price.
-
onSale(optional):
boolean
Whether is on sale.
-
priceListId(optional):
string
The price list ID used for pricing.
-
quantityDiscounted(optional):
integer
The quantity discounted.
-
rawTotalPrice(optional):
number
The raw total price of the recurring charge.
-
salePrice(optional):
number
The sale price
-
shippingSurcharge(optional):
number
Extra handling cost for shipping the product.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the recurring charge price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"rawTotalPrice":{
"description":"The raw total price of the recurring charge.",
"type":"number"
},
"salePrice":{
"description":"The sale price",
"type":"number"
},
"priceListId":{
"description":"The price list ID used for pricing.",
"type":"string"
},
"quantityDiscounted":{
"description":"The quantity discounted.",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"shippingSurcharge":{
"description":"Extra handling cost for shipping the product.",
"type":"number"
},
"onSale":{
"description":"Whether is on sale.",
"type":"boolean"
},
"discountable":{
"description":"Whether discountable.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"currentPriceDetailsSorted":{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
},
"listPrice":{
"description":"The monetary amount of the list price.",
"type":"number"
}
}
}Nested Schema : shopperInput
Type:
objectAdditional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}Map of shopper input keys to values
Nested Schema : items
Type:
Show Source
object-
actionCode(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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(optional):
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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}Nested Schema : values
Type:
objectThe array of values associated with an externalData item.
Show Source
-
dynamic_property_key:
string
This property's name and value will be retrieved from a configurator system, so will be dynamically set.
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}Nested Schema : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"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 : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this price info
-
range(optional):
object range
Represents which specific items are covered by this price info.
-
secondaryCurrencyTaxAmount(optional):
number
The tax amount in secondary currency
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The tax amount in secondary currency",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this price info covers.
-
lowBound(optional):
integer
The lower bound of the range this price info covers, inclusive.
-
size(optional):
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 : currentPriceDetailsSorted
Type:
arrayThe current price details.
Show Source
{
"description":"The current price details.",
"type":"array",
"items":{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount for the recurring charge.
-
amountIsFinal(optional):
boolean
Whether the recurring charge amount is final.
-
currencyCode(optional):
string
The three character currency code for the monetary amounts.
-
detailedUnitPrice(optional):
number
The detailed unit price: amount / quantity. (read-only)
-
discounted(optional):
boolean
Whether the price is discounted.
-
quantity(optional):
integer
The number of items covered by this recurring charge price info
-
range(optional):
object range
Represents which specific items are covered by this recurring charge price info.
-
tax(optional):
number
Monetary tax amount.
{
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"amountIsFinal":{
"description":"Whether the recurring charge amount is final.",
"type":"boolean"
},
"range":{
"description":"Represents which specific items are covered by this recurring charge price info.",
"type":"object",
"properties":{
"lowBound":{
"description":"The lower bound of the range this recurring charge price info covers, inclusive.",
"type":"integer"
},
"highBound":{
"description":"The upper bound of the range this recurring charge price info covers.",
"type":"integer"
},
"size":{
"description":"The number of items in this range, inclusive. (read-only)",
"type":"integer"
}
}
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : range
Type:
objectRepresents which specific items are covered by this recurring charge price info.
Show Source
-
highBound(optional):
integer
The upper bound of the range this recurring charge price info covers.
-
lowBound(optional):
integer
The lower bound of the range this recurring charge price info covers, inclusive.
-
size(optional):
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-
amount:
number
The monetary amount of the payment.
-
amountAuthorized(optional):
number
The monetary amount authorized.
-
authorizationStatus(optional):
array authorizationStatus
Array of authorization status objects.
-
billingAddress(optional):
object billingAddress
Billing address for the order
-
creditCardNumber(optional):
string
The last four digits of the credit card number. (only for TokenizedCreditCards)
-
creditCardType(optional):
string
The type of the credit card. (only for TokenizedCreditCards)
-
currencyCode(optional):
string
The three character currency code. For example: USD.
-
expirationDayOfMonth(optional):
string
A string containing the two digit day of month when the credit card expires. (only for TokenizedCreditCards)
-
expirationMonth(optional):
string
A string containing the two digit month when the credit card expires. (only for TokenizedCreditCards)
-
expirationYear(optional):
string
A string containing the two or four digit year when the credit card expires. (only for TokenizedCreditCards)
-
externalId(optional):
string
The ID for the payment group in an external system (like the OMS)
-
externalSourceId(optional):
string
The external source ID, limited to 6 characters. (only for ExternalPaymentGroups)
-
externalSubtype(optional):
string
The subtype in the external system. Might be "VISA" for a PaymentGroup with an external type of "CreditCard". (only for ExternalPaymentGroups)
-
externalType(optional):
string
The type in the external system. Might be "StoreCredit", "CreditCard", "Check", etc. (only for ExternalPaymentGroups).
-
id(optional):
string
The internal ID of the payment group.
-
IIN(optional):
string
The issuer identification number (first 6 digits) of the credit card.
-
paymentGroupClassType:
string
The class type of the payment group. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
-
paymentMethod:
string
The payment method. Currently supported values are "tokenizedCreditCard" and "externalPaymentGroup".
-
PONumber(optional):
string
The purchase order number.
-
state(optional):
string
The state of this payment group.
-
stateDetail(optional):
string
Details about the state of this payment group.
-
submittedDate(optional):
string
The date the payment was submitted.
-
token(optional):
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":"Billing address for the order",
"type":"object",
"properties":{
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"lastName":{
"description":"Last Name 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"
},
"jobTitle":{
"description":"JOb Title for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Default value of the address.",
"type":"boolean"
},
"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"
},
"repositoryId":{
"description":"Repository ID of the address.",
"type":"string"
},
"faxNumber":{
"description":"Fax Number for this billing address.",
"type":"string"
},
"alias":{
"description":"Nickname or alternate name for address like home/office.",
"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 ISON code of the shipping address.",
"type":"string"
}
},
"required":[
"firstName",
"lastName",
"postalCode",
"address1",
"city",
"selectedCountry",
"selectedState"
]
},
"id":{
"description":"The internal ID of the payment group.",
"type":"string"
},
"state":{
"description":"The state of this payment group.",
"type":"string"
},
"stateDetail":{
"description":"Details about the state of this payment group.",
"type":"string"
},
"currencyCode":{
"description":"The three character currency code. For example: USD.",
"type":"string"
},
"expirationDayOfMonth":{
"description":"A string containing the two digit day of month when the credit card expires. (only for TokenizedCreditCards)",
"type":"string"
}
},
"required":[
"amount",
"paymentGroupClassType",
"paymentMethod"
]
}Nested Schema : authorizationStatus
Type:
arrayArray of authorization status objects.
Show Source
{
"description":"Array of authorization status objects.",
"type":"array",
"items":{
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"transactionSuccess":{
"description":"Whether the transaction was successful.",
"type":"boolean"
},
"errorMessage":{
"description":"The error message, if any.",
"type":"string"
},
"transactionId":{
"description":"The transaction ID.",
"type":"string"
},
"transactionTimestamp":{
"description":"The timestamp of the transaction.",
"type":"string"
}
}
}
}Nested Schema : billingAddress
Type:
objectBilling address for the order
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
alias(optional):
string
Nickname or alternate name for address like home/office.
-
city:
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country for this billing address.
-
email(optional):
string
Email for this billing address.
-
faxNumber(optional):
string
Fax Number for this billing address.
-
firstName:
string
First Name for this billing address.
-
isDefaultAddress(optional):
boolean
Default value of the address.
-
jobTitle(optional):
string
JOb Title for this billing address.
-
lastName:
string
Last Name for this billing address.
-
middleName(optional):
string
Middle Name for this billing address.
-
phoneNumber(optional):
string
Phone Number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
repositoryId(optional):
string
Repository ID of the address.
-
selectedCountry:
string
The selected country of the shipping address.
-
selectedState:
string
The selected state of the shipping address.
-
state(optional):
string
State for this billing address.
-
state_ISOCode(optional):
string
The state ISON code of the shipping address.
-
suffix(optional):
string
suffix for this billing address.
{
"description":"Billing address for the order",
"type":"object",
"properties":{
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"lastName":{
"description":"Last Name 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"
},
"jobTitle":{
"description":"JOb Title for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Default value of the address.",
"type":"boolean"
},
"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"
},
"repositoryId":{
"description":"Repository ID of the address.",
"type":"string"
},
"faxNumber":{
"description":"Fax Number for this billing address.",
"type":"string"
},
"alias":{
"description":"Nickname or alternate name for address like home/office.",
"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 ISON code of the shipping address.",
"type":"string"
}
},
"required":[
"firstName",
"lastName",
"postalCode",
"address1",
"city",
"selectedCountry",
"selectedState"
]
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary amount.
-
errorMessage(optional):
string
The error message, if any.
-
transactionId(optional):
string
The transaction ID.
-
transactionSuccess(optional):
boolean
Whether the transaction was successful.
-
transactionTimestamp(optional):
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 : loyaltyPrograms
Type:
arrayLoyalty Programs Information
Show Source
{
"description":"Loyalty Programs Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository ID",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}
}Nested Schema : shippingAddress
Type:
objectDefault shipping address
Show Source
-
address1(optional):
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
City.
-
country(optional):
string
Country.
-
county(optional):
string
Name of the county.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
state(optional):
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(optional):
string
membershipId of the profile.
-
programId(optional):
string
programId of Loyalty Program
-
programName(optional):
string
programName of Loyalty Program
-
repositoryId(optional):
string
repository ID
-
status(optional):
string
status of Enrollment.
{
"type":"object",
"properties":{
"programName":{
"description":"programName of Loyalty Program",
"type":"string"
},
"repositoryId":{
"description":"repository ID",
"type":"string"
},
"membershipId":{
"description":"membershipId of the profile.",
"type":"string"
},
"programId":{
"description":"programId of Loyalty Program",
"type":"string"
},
"status":{
"description":"status of Enrollment.",
"type":"string"
}
}
}Nested Schema : frequencyAmountTotals
Type:
arrayThe total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
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(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
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-
actualShipDate(optional):
string
The actual shipped date of this shipping group.
-
commerceItemRelationships(optional):
array commerceItemRelationships
The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
-
description(optional):
string
The description of this shipping group. Defaults to the ID.
-
handlingInstructions(optional):
array handlingInstructions
Handling instructions. Currently read-only.
-
id(optional):
string
The ID of this shipping group.
-
priceInfo(optional):
object priceInfo
The pricing details about this shipping group.
-
recurringChargePriceInfo(optional):
object recurringChargePriceInfo
Recurring charge price information.
-
shipOnDate(optional):
string
The date this shipping group is expected to ship upon.
-
shippingAddress(optional):
object shippingAddress
The shipping address for this shipping group.
-
shippingGroupClassType(optional):
string
The class type for the ShippingGroup. Currently must be "hardgoodShippingGroup".
-
shippingMethod(optional):
string
The shipping method.
-
specialInstructions(optional):
object specialInstructions
Special instructions for the shipping group. Keys and values are strings.
-
state(optional):
string
The state of this shipping group.
-
stateDetail(optional):
string
Details about the state of this shipping group.
-
submittedDate(optional):
string
The date the shipping group was submitted.
-
trackingInfo(optional):
array trackingInfo
An array that specifies the tracking info of shipping group. (read-only)
-
trackingNumber(optional):
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":{
"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"
}
}
},
"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"
}
}
},
"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":{
"description":"The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.",
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
},
"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"
}
},
"shippingGroupClassType":{
"description":"The class type for the ShippingGroup. Currently must be \"hardgoodShippingGroup\".",
"type":"string"
}
}
}Nested Schema : commerceItemRelationships
Type:
arrayThe commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.
Show Source
{
"description":"The commerce item relationships are instances of ShippingGroupCommerceItemRelationship that represent how many of which commerce items are included in the order. Please see caution in description of update order. Existing commerce items relationships are matched to input data by id, followed by commerceItemId, followed by commerceItemExternalId.",
"type":"array",
"items":{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"commerceItemExternalId":{
"description":"The referenced commerce item's external ID.",
"type":"string"
},
"id":{
"description":"The native ID of this item.",
"type":"string"
}
}
}
}Nested Schema : handlingInstructions
Type:
arrayHandling instructions. Currently read-only.
Show Source
{
"description":"Handling instructions. Currently read-only.",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : priceInfo
Type:
objectThe pricing details about this shipping group.
Show Source
-
amount(optional):
number
The monetary amount.
-
amountIsFinal(optional):
boolean
Whether the amount is final.
-
currencyCode(optional):
string
The currency code for the monetary amounts.
-
discounted(optional):
boolean
Whether this item is discounted.
-
rawShipping(optional):
number
The monetary amount of the cost of raw shipping.
-
secondaryCurrencyShippingAmount(optional):
number
The secondary currency shipping amount.
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
{
"description":"The pricing details about this shipping group.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether this item is discounted.",
"type":"boolean"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The secondary currency shipping amount.",
"type":"number"
},
"rawShipping":{
"description":"The monetary amount of the cost of raw shipping.",
"type":"number"
},
"amountIsFinal":{
"description":"Whether the amount is final.",
"type":"boolean"
},
"currencyCode":{
"description":"The currency code for the monetary amounts.",
"type":"string"
}
}
}Nested Schema : recurringChargePriceInfo
Type:
objectRecurring charge price information.
Show Source
-
amount(optional):
number
The monetary amount of this recurring charge.
-
currencyCode(optional):
string
The currency code for the monetary amounts. A three character currency code such as USD.
-
frequencyAmountTotals(optional):
array frequencyAmountTotals
The total for each recurring charge frequency
-
frequencyTaxTotals(optional):
array frequencyTaxTotals
The tax for each recurring charge frequency
-
shipping(optional):
number
Cost of shipping the product.
-
subTotal(optional):
number
The sub-total price of the recurring charge.
-
tax(optional):
number
Monetary tax amount.
-
total(optional):
number
The total price of the recurring charge.
-
totalWithoutTax(optional):
number
Total of recurring amount without tax included.
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}Nested Schema : shippingAddress
Type:
objectThe shipping address for this shipping group.
Show Source
-
address1(optional):
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
Name of the county.
-
email(optional):
string
The email address
-
faxNumber(optional):
string
The fax number.
-
firstName(optional):
string
First name.
-
id(optional):
string
ID.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
ownerId(optional):
string
The ID of the owner of this address.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
prefix(optional):
string
Prefix.
-
state(optional):
string
State.
-
suffix(optional):
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:
objectSpecial instructions for the shipping group. Keys and values are strings.
Show Source
{
"description":"Special instructions for the shipping group. Keys and values are strings.",
"type":"object",
"properties":{
"additionalProperties":{
"type":"string"
}
}
}Nested Schema : trackingInfo
Type:
arrayAn array that specifies the tracking info of shipping group. (read-only)
Show Source
{
"description":"An array that specifies the tracking info of shipping group. (read-only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"The carrier name.",
"type":"string"
},
"trackingUrl":{
"description":"The tracking url.",
"type":"string"
},
"carrierId":{
"description":"The carrier ID.",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary value.
-
commerceItemExternalId(optional):
string
The referenced commerce item's external ID.
-
commerceItemId(optional):
string
The referenced commerce item's internal ID.
-
id(optional):
string
The native ID of this item.
-
pointOfNoRevision(optional):
boolean
The boolean that indicates if the item has passed pointOfNoRevision.
-
quantity(optional):
integer
The quantity of items referenced by this relationship.
-
relationshipType(optional):
string
The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.
-
returnedQuantity(optional):
integer
Number of referenced items that were returned.
{
"type":"object",
"properties":{
"commerceItemId":{
"description":"The referenced commerce item's internal ID.",
"type":"string"
},
"amount":{
"description":"The monetary value.",
"type":"number"
},
"quantity":{
"description":"The quantity of items referenced by this relationship.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANTITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"returnedQuantity":{
"description":"Number of referenced items that were returned.",
"type":"integer"
},
"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:
arrayThe total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : frequencyTaxTotals
Type:
arrayThe tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
frequency(optional):
string
The frequency for the item's total e.g. Monthly.
-
total(optional):
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(optional):
string
The frequency for the item's tax e.g. Monthly.
-
tax(optional):
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(optional):
string
The carrier ID.
-
carrierName(optional):
string
The carrier name.
-
trackingNumber(optional):
string
The tracking number.
-
trackingUrl(optional):
string
The tracking url.
{
"type":"object",
"properties":{
"carrierName":{
"description":"The carrier name.",
"type":"string"
},
"trackingUrl":{
"description":"The tracking url.",
"type":"string"
},
"carrierId":{
"description":"The carrier ID.",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
}
}
}Nested Schema : additionalProperties
Type:
objectMap of Additional properties for return request
Show Source
-
property1(optional):
string
additional property 1
-
property2(optional):
string
additional property 2
{
"description":"Map of Additional properties for return request",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
}Nested Schema : originatingOrder
Type:
objectOriginal order information
Show Source
-
approverIds(optional):
array approverIds
List of ids of approvers
-
commerceItems(optional):
array commerceItems
list of commerce items
-
configuratorId(optional):
string
Configuration ID of the configurable product
-
creationTime(optional):
number
Creation tinme for order
-
exchangeRate(optional):
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.
-
gwp(optional):
boolean
-
id(optional):
string
order ID
-
lastModifiedTime(optional):
number
Time at which order was last modified
-
locale(optional):
string
Locale.
-
paymentGroups(optional):
array paymentGroups
List of payment Groups for the order. Related Endpoint operations - submitOrder
-
payShippingInSecondaryCurrency(optional):
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay shipping charges in monetary currency. Additionally, 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.
-
payTaxInSecondaryCurrency(optional):
boolean
A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, 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.
-
priceGroupId(optional):
string
Price list group ID
-
priceInfo(optional):
object priceInfo
The order price information.
-
secondaryCurrencyCode(optional):
string
The currency code of secondary currency associated with the site.
-
shippingGroups(optional):
array shippingGroups
The shipping groups for the order.
-
sourceSystem(optional):
string
The system where the order originated.
-
state(optional):
string
The state of the order
-
submittedDate(optional):
string
Date on which the order was submitted.
-
taxPriceInfo(optional):
object taxPriceInfo
The tax pricing details for the order.
-
totalCommerceItemCount(optional):
number
total number of commerce items in order
{
"description":"Original order information",
"type":"object",
"properties":{
"approverIds":{
"description":"List of ids of approvers",
"type":"array",
"items":{
"type":"string"
}
},
"taxPriceInfo":{
"description":"The tax pricing details for the order.",
"type":"object",
"properties":{
"cityTax":{
"description":"The monetary amount of city tax.",
"type":"number"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"if tax is included in the price",
"type":"boolean"
},
"miscTax":{
"description":"miscellaneous tax",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
}
}
},
"gwp":{
"description":"",
"type":"boolean"
},
"secondaryCurrencyCode":{
"description":"The currency code of secondary currency associated with the site.",
"type":"string"
},
"shippingGroups":{
"description":"The shipping groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The current total tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"shippingMethod":{
"description":"Shipping method",
"type":"string"
}
}
}
},
"lastModifiedTime":{
"description":"Time at which order was last modified",
"type":"number"
},
"priceGroupId":{
"description":"Price list group ID",
"type":"string"
},
"creationTime":{
"description":"Creation tinme for order",
"type":"number"
},
"sourceSystem":{
"description":"The system where the order originated.",
"type":"string"
},
"submittedDate":{
"description":"Date on which the order was submitted.",
"type":"string"
},
"locale":{
"description":"Locale.",
"type":"string"
},
"paymentGroups":{
"description":"List of payment Groups for the order. Related Endpoint operations - submitOrder",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"ID of this payment Group.",
"type":"integer"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"state":{
"description":"The payment state, it can be INCOMPLETE or COMPLETE ",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
}
}
}
},
"payShippingInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay shipping charges in monetary currency. Additionally, 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"
},
"configuratorId":{
"description":"Configuration ID of the configurable product",
"type":"string"
},
"payTaxInSecondaryCurrency":{
"description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, 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":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"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":"total number of commerce items in order",
"type":"number"
},
"id":{
"description":"order ID",
"type":"string"
},
"state":{
"description":"The state of the order",
"type":"string"
},
"commerceItems":{
"description":"list of commerce items",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
}
}
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name",
"type":"string"
},
"id":{
"description":"commerce item ID",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
}
}
}
}
}
}Nested Schema : profile
Type:
objectProfile Information for the order.
Show Source
-
email(optional):
string
Email address of the profile
-
firstName(optional):
string
First name of profile.
-
lastName(optional):
string
Last name of profile.
-
login(optional):
string
Login ID to be used.Defaults for email if not passed.
-
middleName(optional):
string
Middle name of profile.
-
shippingAddress(optional):
object shippingAddress
The shipping address for this shipping group.
{
"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"
},
"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"
},
"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"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"repositoryId":{
"description":"ID.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
},
"middleName":{
"description":"Middle name of profile.",
"type":"string"
},
"login":{
"description":"Login ID to be used.Defaults for email if not passed.",
"type":"string"
},
"email":{
"description":"Email address of the profile",
"type":"string"
}
}
}Nested Schema : refundMethodList
Type:
arrayList of Refund methods of return request
Show Source
{
"description":"List of Refund methods of return request",
"type":"array",
"items":{
"type":"object",
"properties":{
"refundType":{
"description":"Type of the refund. For example this can be creditCard, tokenizedCreditCard\tetc",
"type":"string"
},
"amount":{
"description":"The amount pertaining to the refund method",
"type":"number"
},
"maxRefundAmount":{
"description":"The maximum amount that can be refunded from the refund method",
"type":"number"
}
}
}
}Nested Schema : returnItemList
Type:
arrayList of returnable Items
Show Source
{
"description":"List of returnable Items",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity returned",
"type":"number"
},
"quantityAvailable":{
"description":"Quantity Available",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"secondaryCurrencyActualTaxRefundShare":{
"description":"Actual Tax refund at return item level in secondary currency",
"type":"number"
},
"returnItemId":{
"description":"ID of the return Item",
"type":"string"
},
"shippingGroupId":{
"description":"Shipping group ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingSurchargeRefundShare":{
"description":"Actual shipping surcharge refund at return item level in secondary currency",
"type":"number"
},
"catalogRefId":{
"description":"The reference ID of the catalog this return item references. Typically the SKU ID.",
"type":"string"
},
"quantityWithFractionReceived":{
"description":"Quantity recieved in fraction",
"type":"number"
},
"suggestedShippingRefundShare":{
"description":"Suggested Shipping Refund",
"type":"number"
},
"commerceItemId":{
"description":"Commerce ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingRefundShare":{
"description":"Actual shipping refund at return item level in secondary currency",
"type":"number"
},
"disposition":{
"description":"Disposition reason",
"type":"string"
},
"quantityShipped":{
"description":"Quantity of this item that was originally shipped",
"type":"number"
},
"actualShippingSurchargeRefundShare":{
"description":"Actual Shipping Surcharge Refund at Item level",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"actualShippingRefundShare":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"additionalProperties":{
"description":"Map of Additional properties for each return item",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
},
"state":{
"description":"state at return item level",
"type":"string"
},
"suggestedRefundAmount":{
"description":"Suggested Refund Amount Item level",
"type":"number"
},
"actualTaxRefundShare":{
"description":"Actual Tax Refund at Item level",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"string"
},
"refundAmount":{
"description":"Refund Amount at Item level",
"type":"number"
}
}
}
}Nested Schema : trackingNumber
Type:
arrayList of tracking numbers for the return request
Show Source
{
"description":"List of tracking numbers for the return request",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : approverIds
Type:
arrayList of ids of approvers
Show Source
{
"description":"List of ids of approvers",
"type":"array",
"items":{
"type":"string"
}
}Nested Schema : commerceItems
Type:
arraylist of commerce items
Show Source
{
"description":"list of commerce items",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
}
}
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name",
"type":"string"
},
"id":{
"description":"commerce item ID",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
}
}
}
}Nested Schema : paymentGroups
Type:
arrayList of payment Groups for the order. Related Endpoint operations - submitOrder
Show Source
{
"description":"List of payment Groups for the order. Related Endpoint operations - submitOrder",
"type":"array",
"items":{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"ID of this payment Group.",
"type":"integer"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"state":{
"description":"The payment state, it can be INCOMPLETE or COMPLETE ",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
}
}
}
}Nested Schema : priceInfo
Type:
objectThe order price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
primaryCurrencyTotal(optional):
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(optional):
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(optional):
number
The shipping surcharges added at item level in monetary currency.
-
secondaryCurrencyTaxAmount(optional):
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(optional):
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. -
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
The sub-total amount.
-
tax(optional):
number
The total tax amount.
-
taxExclusiveAmount(optional):
number
Total excluding shipping and tax in monetary currency
-
total(optional):
number
The order total.
{
"description":"The order price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. <br/>Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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 total order amount.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. 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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.<br/>3. 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":"Extra handling costs for shipping the products.",
"type":"number"
},
"taxExclusiveAmount":{
"description":"Total excluding shipping and tax in monetary currency",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"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.<br/>Prerequisites for the value in this Attribute:<br/>1. PriceList configured for the site is in custom currency.<br/>2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"The shipping surcharges added at item level in monetary currency.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}Nested Schema : shippingGroups
Type:
arrayThe shipping groups for the order.
Show Source
{
"description":"The shipping groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The current total tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"shippingMethod":{
"description":"Shipping method",
"type":"string"
}
}
}
}Nested Schema : taxPriceInfo
Type:
objectThe tax pricing details for the order.
Show Source
-
amount(optional):
number
The monetary amount.
-
cityTax(optional):
number
The monetary amount of city tax.
-
countyTax(optional):
number
The monetary amount of county tax.
-
currencyCode(optional):
string
The three character currency code.
-
isTaxIncluded(optional):
boolean
if tax is included in the price
-
miscTax(optional):
number
miscellaneous tax
-
secondaryCurrencyTaxAmount(optional):
number
The secondary currency tax amount.
-
stateTax(optional):
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"
},
"secondaryCurrencyTaxAmount":{
"description":"The secondary currency tax amount.",
"type":"number"
},
"amount":{
"description":"The monetary amount.",
"type":"number"
},
"countyTax":{
"description":"The monetary amount of county tax.",
"type":"number"
},
"isTaxIncluded":{
"description":"if tax is included in the price",
"type":"boolean"
},
"miscTax":{
"description":"miscellaneous tax",
"type":"number"
},
"stateTax":{
"description":"Tax amount for the state.",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
catalogRefId(optional):
string
The reference ID of the catalog this commerce item references. Typically the SKU ID.
-
id(optional):
string
commerce item ID
-
priceInfo(optional):
object priceInfo
Details about pricing.
-
productDisplayName(optional):
string
The product's display name
-
productId(optional):
string
The ID of the product.
-
quantity(optional):
integer
The quantity included.
{
"type":"object",
"properties":{
"priceInfo":{
"description":"Details about pricing.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this order.",
"type":"number"
},
"currencyCode":{
"description":"Indicates the currency of the price. For example, USD indicates that the price is in US dollars.",
"type":"string"
}
}
},
"quantity":{
"description":"The quantity included.",
"type":"integer"
},
"productId":{
"description":"The ID of the product.",
"type":"string"
},
"productDisplayName":{
"description":"The product's display name",
"type":"string"
},
"id":{
"description":"commerce item ID",
"type":"string"
},
"catalogRefId":{
"description":"The reference ID of the catalog this commerce item references. Typically the SKU ID.",
"type":"string"
}
}
}Nested Schema : priceInfo
Type:
objectDetails about pricing.
Show Source
-
amount(optional):
number
The monetary amount of this order.
-
currencyCode(optional):
string
Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
{
"description":"Details about pricing.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this order.",
"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 : items
Type:
Show Source
object-
amount(optional):
number
The amount associated with this Payment Group.
-
amountAuthorized(optional):
number
The amount authorized with this Payment Group.
-
currencyCode(optional):
string
The three character currency code.
-
IIN(optional):
string
The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout.
-
paymentGroupId(optional):
integer
ID of this payment Group.
-
PONumber(optional):
string
Purchase order number for invoice payment. Payment type: invoice
-
state(optional):
number
The payment state, it can be INCOMPLETE or COMPLETE
-
token(optional):
string
Token associated with this Payment Group.
{
"type":"object",
"properties":{
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"ID of this payment Group.",
"type":"integer"
},
"amountAuthorized":{
"description":"The amount authorized with this Payment Group.",
"type":"number"
},
"amount":{
"description":"The amount associated with this Payment Group.",
"type":"number"
},
"state":{
"description":"The payment state, it can be INCOMPLETE or COMPLETE ",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code.",
"type":"string"
},
"IIN":{
"description":"The issuer identification number (first 6 digits) of any IIN payment type card, e.g. credit card. This is normally used to allow any credit card type based promotions to be applied prior to final checkout.",
"type":"string"
},
"token":{
"description":"Token associated with this Payment Group.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
priceInfo(optional):
object priceInfo
The price information.
-
shippingMethod(optional):
string
Shipping method
{
"type":"object",
"properties":{
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The current total tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"shippingMethod":{
"description":"Shipping method",
"type":"string"
}
}
}Nested Schema : priceInfo
Type:
objectThe price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
secondaryCurrencyTaxAmount(optional):
number
The current total tax amount in monetry currency
-
shippingTax(optional):
number
Shipping tax
{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"The current total tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}Nested Schema : shippingAddress
Type:
objectThe shipping address for this shipping group.
Show Source
-
address1(optional):
string
Address Line 1.
-
address2(optional):
string
Address Line 2.
-
address3(optional):
string
Address Line 3.
-
city(optional):
string
City.
-
companyName(optional):
string
Company name.
-
country(optional):
string
Country.
-
county(optional):
string
Name of the county.
-
firstName(optional):
string
First name.
-
jobTitle(optional):
string
Job title.
-
lastName(optional):
string
Last name.
-
middleName(optional):
string
Middle name.
-
phoneNumber(optional):
string
Phone number.
-
postalCode(optional):
string
Postal code.
-
repositoryId(optional):
string
ID.
-
state(optional):
string
State.
{
"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"
},
"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"
},
"firstName":{
"description":"First name.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"repositoryId":{
"description":"ID.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
}
}
}Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The amount pertaining to the refund method
-
maxRefundAmount(optional):
number
The maximum amount that can be refunded from the refund method
-
refundType(optional):
string
Type of the refund. For example this can be creditCard, tokenizedCreditCard etc
{
"type":"object",
"properties":{
"refundType":{
"description":"Type of the refund. For example this can be creditCard, tokenizedCreditCard\tetc",
"type":"string"
},
"amount":{
"description":"The amount pertaining to the refund method",
"type":"number"
},
"maxRefundAmount":{
"description":"The maximum amount that can be refunded from the refund method",
"type":"number"
}
}
}Nested Schema : items
Type:
Show Source
object-
actualShippingRefundShare(optional):
number
Actual Shipping Refund at Item level
-
actualShippingSurchargeRefundShare(optional):
number
Actual Shipping Surcharge Refund at Item level
-
actualTaxRefundShare(optional):
number
Actual Tax Refund at Item level
-
additionalProperties(optional):
object additionalProperties
Map of Additional properties for each return item
-
catalogRefId(optional):
string
The reference ID of the catalog this return item references. Typically the SKU ID.
-
comments(optional):
string
Comments at ReturnItem Level
-
commerceItemId(optional):
string
Commerce ID of the returned item
-
disposition(optional):
string
Disposition reason
-
dispositionReason(optional):
string
Disposition Reason
-
quantityAvailable(optional):
number
Quantity Available
-
quantityReturned(optional):
number
Quantity returned
-
quantityShipped(optional):
number
Quantity of this item that was originally shipped
-
quantityWithFractionReceived(optional):
number
Quantity recieved in fraction
-
refundAmount(optional):
number
Refund Amount at Item level
-
returnItemId(optional):
string
ID of the return Item
-
returnReason(optional):
string
Reason to return an Item
-
secondaryCurrencyActualShippingRefundShare(optional):
number
Actual shipping refund at return item level in secondary currency
-
secondaryCurrencyActualShippingSurchargeRefundShare(optional):
number
Actual shipping surcharge refund at return item level in secondary currency
-
secondaryCurrencyActualTaxRefundShare(optional):
number
Actual Tax refund at return item level in secondary currency
-
shippingGroupId(optional):
string
Shipping group ID of the returned item
-
state(optional):
string
state at return item level
-
suggestedRefundAmount(optional):
number
Suggested Refund Amount Item level
-
suggestedShippingRefundShare(optional):
number
Suggested Shipping Refund
{
"type":"object",
"properties":{
"quantityReturned":{
"description":"Quantity returned",
"type":"number"
},
"quantityAvailable":{
"description":"Quantity Available",
"type":"number"
},
"comments":{
"description":"Comments at ReturnItem Level",
"type":"string"
},
"secondaryCurrencyActualTaxRefundShare":{
"description":"Actual Tax refund at return item level in secondary currency",
"type":"number"
},
"returnItemId":{
"description":"ID of the return Item",
"type":"string"
},
"shippingGroupId":{
"description":"Shipping group ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingSurchargeRefundShare":{
"description":"Actual shipping surcharge refund at return item level in secondary currency",
"type":"number"
},
"catalogRefId":{
"description":"The reference ID of the catalog this return item references. Typically the SKU ID.",
"type":"string"
},
"quantityWithFractionReceived":{
"description":"Quantity recieved in fraction",
"type":"number"
},
"suggestedShippingRefundShare":{
"description":"Suggested Shipping Refund",
"type":"number"
},
"commerceItemId":{
"description":"Commerce ID of the returned item",
"type":"string"
},
"secondaryCurrencyActualShippingRefundShare":{
"description":"Actual shipping refund at return item level in secondary currency",
"type":"number"
},
"disposition":{
"description":"Disposition reason",
"type":"string"
},
"quantityShipped":{
"description":"Quantity of this item that was originally shipped",
"type":"number"
},
"actualShippingSurchargeRefundShare":{
"description":"Actual Shipping Surcharge Refund at Item level",
"type":"number"
},
"returnReason":{
"description":"Reason to return an Item",
"type":"string"
},
"actualShippingRefundShare":{
"description":"Actual Shipping Refund at Item level",
"type":"number"
},
"additionalProperties":{
"description":"Map of Additional properties for each return item",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
},
"state":{
"description":"state at return item level",
"type":"string"
},
"suggestedRefundAmount":{
"description":"Suggested Refund Amount Item level",
"type":"number"
},
"actualTaxRefundShare":{
"description":"Actual Tax Refund at Item level",
"type":"number"
},
"dispositionReason":{
"description":"Disposition Reason",
"type":"string"
},
"refundAmount":{
"description":"Refund Amount at Item level",
"type":"number"
}
}
}Nested Schema : additionalProperties
Type:
objectMap of Additional properties for each return item
Show Source
-
property1(optional):
string
additional property 1
-
property2(optional):
string
additional property 2
{
"description":"Map of Additional properties for each return item",
"type":"object",
"properties":{
"property2":{
"description":"additional property 2",
"type":"string"
},
"property1":{
"description":"additional property 1",
"type":"string"
}
}
}Example Response (application/json)
{
"cancelOrder":{
"gwp":false,
"secondaryCurrencyCode":null,
"defaultCatalog":null,
"salesChannel":"contactCenter",
"submittedDate":"2018-05-28T13:29:09.000Z",
"configuratorId":null,
"responseCode":null,
"organizationId":null,
"relationships":[
],
"exchangeRate":null,
"id":"o270411",
"state":"INCOMPLETE_CANCEL",
"taxCalculated":true,
"commerceItems":[
{
"deactivationDate":null,
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":null,
"preOrderQuantity":0,
"assetKey":"12345",
"priceInfo":{
"discounted":true,
"amount":0,
"secondaryCurrencyShippingSurcharge":0,
"rawTotalPrice":49.99,
"salePrice":0,
"priceListId":"listPrices",
"quantityDiscounted":0,
"amountIsFinal":true,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currencyCode":"USD",
"currentPriceDetailsSorted":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"orderDiscountShare":0,
"tax":0,
"detailedUnitPrice":0,
"currencyCode":"USD"
}
],
"listPrice":49.99
},
"catalogId":null,
"externalRecurringChargeDetails":null,
"externalPriceDetails":null,
"actionCode":"-",
"id":"ci26000411",
"serviceId":null,
"serviceAccountId":null,
"quantity":1,
"productId":"Product_21Cxi",
"externalId":null,
"parentAssetKey":null,
"originalCommerceItemId":"ci20000412",
"rootAssetKey":null,
"catalogRefId":"Sku_21Dxy",
"customerAccountId":null,
"recurringChargePriceInfo":null,
"lineAttributes":[
],
"catalogKey":null,
"productDisplayName":"Dora the Explorer - Season 1",
"siteId":"siteUS",
"shopperInput":{
},
"activationDate":null,
"asset":false,
"backOrderQuantity":0
}
],
"freezeDate":null,
"shippingGroups":[
{
"shippingMethod":"freeShippingMethod",
"description":"sg200412",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"shippingTax":2,
"amount":0,
"secondaryCurrencyShippingAmount":0,
"rawShipping":0,
"amountIsFinal":true,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"faxNumber":null,
"middleName":null,
"state":"NY",
"email":"kim@example.com"
},
"commerceItemRelationships":[
{
"commerceItemId":"ci26000411",
"amount":0,
"quantity":1,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"id":"r260384",
"state":"INITIAL"
}
],
"id":"sg260411",
"state":"INITIAL",
"stateDetail":null,
"trackingNumber":null,
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"profile":{
"firstName":"Kim",
"lastName":"Anderson",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"version":2,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"faxNumber":null,
"middleName":null,
"id":"se-980031",
"state":"NY"
},
"middleName":null,
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"defaultPriceListGroup":null,
"paymentInitiatedEmailSent":false,
"payShippingInSecondaryCurrency":null,
"shippingGroupCount":1,
"taxExemptionCode":null,
"orderAction":"cancelOrder",
"profileId":"se-570031",
"activeQuoteOrderId":null,
"approverIds":[
],
"lastModifiedTime":1.527600124827E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.527514131E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"locale":"en",
"paymentGroups":[
],
"payTaxInSecondaryCurrency":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"frequencyAmountTotals":{
},
"secondaryCurrencyShippingAmount":0,
"secondaryCurrencyTotal":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":0,
"rawSubtotal":0,
"frequencyTaxTotals":{
},
"total":0,
"shipping":0,
"primaryCurrencyTotal":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"catalogId":null,
"totalCommerceItemCount":1,
"externalContext":false,
"quoteInfo":null,
"taxPriceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"valueAddedTax":0,
"countyTax":3,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":3,
"miscTaxInfo":{
},
"countryTax":0,
"cityTax":0,
"amountIsFinal":true,
"currencyCode":"USD"
},
"defaultAdditionalPriceListGroups":null,
"creationSiteId":"siteUS",
"lastModifiedDate":"2018-05-29T13:22:04.827Z",
"approvalSystemMessages":[
],
"approverMessages":[
],
"message":null,
"paymentGroupCount":0,
"recurringChargePriceInfo":null,
"organization":null,
"siteId":"siteUS"
},
"links":[
{
"rel":"self",
"href":"http://agent.example.com:9080/ccagentui/v1/orders/initiateCancelOrder"
}
],
"returnRequest":{
"agentId":null,
"authorizationDate":"2018-05-29T13:21:58.131Z",
"refundSubtotal":80.99,
"relatedReplacementOrders":[
],
"refundMethodList":[
{
"refundType":"manualRefund",
"amount":80.99,
"maximumRefundAmount":-1
}
],
"allocatedAmount":80.99,
"originatingOrder":{
"gwp":false,
"secondaryCurrencyCode":null,
"defaultCatalog":null,
"salesChannel":"contactCenter",
"submittedDate":"2018-05-28T13:29:09.000Z",
"configuratorId":null,
"responseCode":null,
"organizationId":null,
"relationships":[
{
"paymentGroupId":"pg180414",
"amount":80.99,
"relationshipType":"ORDERAMOUNT",
"id":"r200390"
}
],
"exchangeRate":null,
"id":"o210411",
"state":"SUBMITTED",
"taxCalculated":true,
"commerceItems":[
{
"deactivationDate":null,
"returnedQuantity":0,
"availabilityDate":null,
"externalData":[
],
"billingAccountId":null,
"preOrderQuantity":0,
"assetKey":"12345",
"priceInfo":{
"discounted":false,
"amount":49.99,
"secondaryCurrencyShippingSurcharge":0,
"rawTotalPrice":49.99,
"salePrice":0,
"priceListId":"listPrices",
"quantityDiscounted":0,
"amountIsFinal":false,
"onSale":false,
"shippingSurcharge":0,
"discountable":true,
"currencyCode":"USD",
"currentPriceDetailsSorted":[
{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":49.99,
"quantity":1,
"amountIsFinal":false,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"orderDiscountShare":0,
"tax":4,
"detailedUnitPrice":49.99,
"currencyCode":"USD"
}
],
"listPrice":49.99
},
"catalogId":null,
"externalRecurringChargeDetails":null,
"externalPriceDetails":null,
"actionCode":null,
"id":"ci20000412",
"serviceId":null,
"serviceAccountId":null,
"quantity":1,
"productId":"Product_21Cxi",
"externalId":null,
"parentAssetKey":null,
"originalCommerceItemId":null,
"rootAssetKey":null,
"catalogRefId":"Sku_21Dxy",
"customerAccountId":null,
"recurringChargePriceInfo":null,
"lineAttributes":[
],
"catalogKey":null,
"productDisplayName":"Dora the Explorer - Season 1",
"siteId":"siteUS",
"shopperInput":{
},
"activationDate":null,
"asset":false,
"backOrderQuantity":0
}
],
"freezeDate":null,
"shippingGroups":[
{
"shippingMethod":"standardShippingMethod",
"description":"sg200412",
"submittedDate":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"shippingTax":2,
"amount":25,
"secondaryCurrencyShippingAmount":0,
"rawShipping":25,
"amountIsFinal":false,
"currencyCode":"USD"
},
"shipOnDate":null,
"actualShipDate":null,
"specialInstructions":{
},
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"faxNumber":null,
"middleName":null,
"state":"NY",
"email":"kim@example.com"
},
"commerceItemRelationships":[
{
"commerceItemId":"ci20000412",
"amount":0,
"quantity":1,
"pointOfNoRevision":false,
"relationshipType":"SHIPPINGQUANTITY",
"returnedQuantity":0,
"range":{
"lowBound":0,
"highBound":0,
"size":1
},
"commerceItemExternalId":null,
"id":"r200388",
"state":"INITIAL"
}
],
"id":"sg200412",
"state":"INITIAL",
"stateDetail":null,
"trackingNumber":null,
"handlingInstructions":[
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
],
"taxExempt":false,
"profile":{
"firstName":"Kim",
"lastName":"Anderson",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"version":2,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"faxNumber":null,
"middleName":null,
"id":"se-980031",
"state":"NY"
},
"middleName":null,
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"defaultPriceListGroup":null,
"paymentInitiatedEmailSent":false,
"payShippingInSecondaryCurrency":null,
"shippingGroupCount":1,
"taxExemptionCode":null,
"orderAction":"order",
"profileId":"se-570031",
"activeQuoteOrderId":null,
"approverIds":[
],
"lastModifiedTime":1.527514149E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.527514131E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"locale":"en",
"paymentGroups":[
{
"PONumber":null,
"amountAuthorized":80.99,
"amount":80.99,
"gatewayName":null,
"paymentProps":{
},
"submittedDate":"2018-05-28T13:29:09.000Z",
"authorizationStatus":[
{
"amount":80.99,
"statusProps":{
},
"transactionSuccess":true,
"errorMessage":null,
"externalStatusProps":[
],
"transactionId":null,
"transactionTimestamp":null
}
],
"paymentGroupClassType":"invoiceRequest",
"paymentMethod":"invoiceRequest",
"billingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"faxNumber":null,
"middleName":null,
"state":"NY",
"email":"kim@example.com"
},
"id":"pg180414",
"state":"PAYMENT_DEFERRED",
"debitStatus":[
],
"currencyCode":"USD"
}
],
"payTaxInSecondaryCurrency":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":49.99,
"frequencyAmountTotals":{
},
"secondaryCurrencyShippingAmount":0,
"secondaryCurrencyTotal":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":6,
"rawSubtotal":49.99,
"frequencyTaxTotals":{
},
"total":80.99,
"shipping":25,
"primaryCurrencyTotal":49.99,
"amountIsFinal":false,
"currencyCode":"USD"
},
"catalogId":null,
"totalCommerceItemCount":1,
"externalContext":false,
"quoteInfo":null,
"taxPriceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":6,
"valueAddedTax":0,
"countyTax":3,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":3,
"miscTaxInfo":{
},
"countryTax":0,
"cityTax":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"defaultAdditionalPriceListGroups":null,
"creationSiteId":"siteUS",
"lastModifiedDate":"2018-05-28T13:29:09.000Z",
"approvalSystemMessages":[
],
"approverMessages":[
],
"message":null,
"paymentGroupCount":1,
"recurringChargePriceInfo":null,
"organization":null,
"siteId":"siteUS"
},
"suggestedShippingRefund":25,
"returnPaymentState":"Refund",
"orderCurrencyCode":"USD",
"processImmediately":false,
"processName":"Return",
"returnAdjustedOrderId":"o270412",
"returnCalculationOrder":{
"gwp":false,
"secondaryCurrencyCode":null,
"defaultCatalog":null,
"salesChannel":"contactCenter",
"submittedDate":"2018-05-28T13:29:09.000Z",
"configuratorId":null,
"responseCode":null,
"organizationId":null,
"relationships":[
{
"paymentGroupId":"pg240413",
"amount":80.99,
"relationshipType":"ORDERAMOUNT",
"id":"r260389"
}
],
"exchangeRate":null,
"id":"o270413",
"state":"SUBMITTED",
"taxCalculated":true,
"commerceItems":[
],
"freezeDate":null,
"shippingGroups":[
],
"taxExempt":false,
"profile":{
"firstName":"Kim",
"lastName":"Anderson",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"version":2,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"faxNumber":null,
"middleName":null,
"id":"se-980031",
"state":"NY"
},
"middleName":null,
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"defaultPriceListGroup":null,
"paymentInitiatedEmailSent":false,
"payShippingInSecondaryCurrency":null,
"shippingGroupCount":0,
"taxExemptionCode":null,
"orderAction":"order",
"profileId":"se-570031",
"activeQuoteOrderId":null,
"approverIds":[
],
"lastModifiedTime":1.527600124709E12,
"priceGroupId":"defaultPriceGroup",
"creationTime":1.527514131E12,
"sourceSystem":"Cloud Commerce",
"gwpMarkers":[
],
"locale":"en",
"paymentGroups":[
{
"PONumber":null,
"amountAuthorized":80.99,
"amount":80.99,
"gatewayName":null,
"paymentProps":{
},
"submittedDate":"2018-05-28T13:29:09.000Z",
"authorizationStatus":[
{
"amount":80.99,
"statusProps":{
},
"transactionSuccess":true,
"errorMessage":null,
"externalStatusProps":[
],
"transactionId":null,
"transactionTimestamp":null
}
],
"paymentGroupClassType":"invoiceRequest",
"paymentMethod":"invoiceRequest",
"billingAddress":{
"country":"US",
"lastName":"Anderson",
"address3":null,
"address2":null,
"city":"Syracuse",
"address1":"21 Cedar Ave",
"prefix":null,
"companyName":null,
"jobTitle":null,
"postalCode":"13202",
"county":null,
"ownerId":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"faxNumber":null,
"middleName":null,
"state":"NY",
"email":"kim@example.com"
},
"id":"pg240413",
"state":"PAYMENT_DEFERRED",
"debitStatus":[
],
"currencyCode":"USD"
}
],
"payTaxInSecondaryCurrency":null,
"priceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"frequencyAmountTotals":{
},
"secondaryCurrencyShippingAmount":0,
"secondaryCurrencyTotal":0,
"manualAdjustmentTotal":0,
"discountAmount":0,
"tax":0,
"rawSubtotal":0,
"frequencyTaxTotals":{
},
"total":0,
"shipping":0,
"primaryCurrencyTotal":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"catalogId":null,
"totalCommerceItemCount":0,
"externalContext":false,
"quoteInfo":null,
"taxPriceInfo":{
"discounted":false,
"secondaryCurrencyTaxAmount":0,
"amount":0,
"valueAddedTax":0,
"countyTax":0,
"isTaxIncluded":false,
"miscTax":0,
"districtTax":0,
"stateTax":0,
"miscTaxInfo":null,
"countryTax":0,
"cityTax":0,
"amountIsFinal":false,
"currencyCode":"USD"
},
"defaultAdditionalPriceListGroups":null,
"creationSiteId":"siteUS",
"lastModifiedDate":"2018-05-29T13:22:04.709Z",
"approvalSystemMessages":[
],
"approverMessages":[
],
"message":null,
"paymentGroupCount":1,
"recurringChargePriceInfo":null,
"organization":null,
"siteId":"siteUS"
},
"state":"incomplete",
"unAdjustedRefundSubtotal":49.99,
"returnItemCount":1,
"trackingNumber":null,
"totalOrderPromotionValueAdjustmentChange":0,
"comments":null,
"profile":{
"firstName":"Kim",
"lastName":"Anderson",
"loyaltyPrograms":[
],
"shippingAddress":{
"country":"US",
"firstName":"Kim",
"lastName":"Anderson",
"city":"Syracuse",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"repositoryId":"se-980031",
"middleName":null,
"state":"NY"
},
"middleName":null,
"id":"se-570031",
"login":"kim@example.com",
"parentOrganization":null,
"email":"kim@example.com"
},
"suggestedTaxRefund":6,
"nonReturnItemCostAdjustments":[
],
"replacementOrder":null,
"actualShippingRefund":25,
"actualTaxRefund":6,
"otherRefund":0,
"processed":false,
"returnLabel":null,
"totalItemRefund":49.99,
"authorizationNumber":null,
"returningItems":true,
"exchangeProcess":false,
"replacingItems":false,
"returnFee":0,
"totalReturnItemRefund":49.99,
"submitExchangeAllowed":false,
"additionalProperties":{
},
"originOfReturn":null,
"totalRefundAmount":80.99,
"unallocatedAmount":0,
"nonReturnItemSubtotalAdjustment":0,
"originatingOrderId":"o210411",
"adjustmentAmount":31,
"replaceItemCount":0,
"returnItemList":[
{
"quantityReturned":0,
"quantityToReturn":1,
"quantityAvailable":1,
"returnItemId":"r200388",
"suggestedTaxRefundShare":4,
"itemCurrencyCode":"USD",
"quantityToExchange":0,
"shippingGroupId":"sg200412",
"description":null,
"catalogRefId":"Sku_21Dxy",
"suggestedShippingRefundShare":25,
"commerceItemId":"ci20000412",
"disposition":null,
"quantityShipped":1,
"returnReason":"cancelOrder",
"itemCostAdjustments":[
{
"commerceItemId":"ci20000412",
"amountAdjustment":-49.99,
"shippingGroupId":"sg200412",
"quantityAdjusted":1,
"shippingShareAdjustment":0,
"orderDiscountShareAdjustment":0,
"manualAdjustmentShareAdjustment":0,
"taxShareAdjustment":-4
},
{
"commerceItemId":"ci20000412",
"amountAdjustment":0,
"shippingGroupId":"sg200412",
"quantityAdjusted":0,
"shippingShareAdjustment":-25,
"orderDiscountShareAdjustment":0,
"manualAdjustmentShareAdjustment":0,
"taxShareAdjustment":0
}
],
"actualShippingRefundShare":25,
"actualTaxRefundShare":6,
"suggestedRefundAmount":49.99,
"quantityReceived":0,
"refundAmount":49.99
}
]
}
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100095|The order or return request does not belong to the current organization of the shopper profile|
|100096|The organization associated to the order or return request was deleted / does not exist|
|100097|The organization associated to the order or return request is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization|
|28107|If no order is found of the order id which is mentioned in request paylaod.|
|200106|No order data specified|
|200105|No Order id specified in request.|
|28315|Error occurred while updating the order.|
|200115|Error occurred at the time of pricing.|
|28364|Error occurred when quote is not allowed.|
|30015|SiteId passed in x-ccsite header is currently inactive|
|30014|SiteId passed in x-ccsite header is invalid or the site was deleted|
|28365|Error occurred while requesting for quote|
|28300|Internal error while creating the order|
|100101|The shopper profile does not belong to organization passed in the header|
|103000|An error occurred while updating the order.|
Body ()
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"type":{
"description":"The URI to the HTTP state code definition",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"errors":{
"description":"An optional list of errors if multiple errors were encountered",
"type":"array",
"items":{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
{
"description":"An optional list of errors if multiple errors were encountered",
"type":"array",
"items":{
"type":"object",
"properties":{
"errorCode":{
"description":"The numerical code identifying the error",
"type":"string"
},
"message":{
"description":"The localized message describing the error",
"type":"string"
},
"devMessage":{
"description":"An optional non-localized message containing technical information for developers",
"type":"string"
},
"moreInfo":{
"description":"An optional non-localized message with more information",
"type":"string"
},
"o:errorPath":{
"description":"An optional machine readable description of where the error occurred",
"type":"string"
},
"status":{
"description":"The HTTP status code",
"type":"string"
}
}
}
}Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
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"
}
}
}