Root Schema : updateOrder_response
Type: object
Show Source
{
"properties":{
"shippingGroups":{
"description":"The shipping groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"surcharge":{
"description":"The shipping surcharge.",
"type":"number"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"The shipping tax.",
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"secondaryCurrencyShipingAmount":{
"description":"shipping amount in monetry currency ",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"description":"The description of the shipping method.",
"type":"string"
}
}
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location ID of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The current total shipping amount in monetry currency ",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The current total in loyalty points in case of multi currency",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The current total (sum of shipping and tax)amount in monetry currency",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"Extra handling costs for shipping the products in monetry currency.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products.",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"selectedCountry":{
"description":"Country code.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"alias":{
"description":"Address alias.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"selectedState":{
"description":"State code.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
},
"state_ISOCode":{
"description":"State ISO code.",
"type":"string"
}
}
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceId":{
"description":"Repository ID",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the shipping group.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"active":{
"description":"active or not.",
"type":"boolean"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
}
}
},
"creationTime":{
"description":"The creation time in long seconds.",
"type":"number"
},
"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"
},
"sourceSystem":{
"description":"The system where the order originated.",
"type":"string"
},
"dynamicProperties":{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"approvalSystemMessages":{
"description":"An array of approval messages when order going in pending approval state",
"type":"array",
"items":{
"type":"string"
}
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"secondaryCurrencyShipingAmount":{
"description":"shipping amount in monetry currency ",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
}
},
"payments":{
"description":"Payment details for the order, including additional properties specific to the payment type.",
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"description":"Payment group ID.",
"type":"string"
},
"savedCardId":{
"description":"ID of the saved card associated with the payment group.",
"type":"string"
},
"amount":{
"description":"Amount authorized from the payment group.",
"type":"number"
},
"balance":{
"description":"Total available balance on the gift card.",
"type":"number"
},
"gatewayName":{
"description":"Payment gateway name. e.g. chaseCreditCard.",
"type":"string"
},
"giftCardNumber":{
"description":"Gift card number.",
"type":"string"
},
"paymentMethod":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
"type":"string"
},
"isAmountRemaining":{
"description":"A boolean to decide if more payment can be made from this payment group.",
"type":"boolean"
},
"paymentState":{
"description":"The state of the payment group. e.g. AUTHORIZED.",
"type":"string"
},
"maskedCardNumber":{
"description":"Masked gift card number.",
"type":"string"
}
}
}
},
"cartName":{
"description":"Cart name for this order.",
"type":"string"
},
"creationDate":{
"description":"The creation date in ISO format.",
"type":"string"
},
"uuid":{
"description":"The unique ID for the order.",
"type":"string"
},
"orderAction":{
"description":"The action performed on the order.",
"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"
}
}
},
"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"
}
}
},
"discountInfo":{
"description":"The discount information.",
"type":"object",
"properties":{
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"orderDiscountDescList":{
"description":"The list of all the order discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon code.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"secondaryCurrencyShippingDiscount":{
"description":"The shipping discount in secondary currency in case of mix currency scenario.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
},
"pricingMessages":{
"description":"The Pricing messages information.",
"type":"object",
"properties":{
"giftWithPurchaseMessages":{
"description":"The gift with purchase messages information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"summary":{
"description":"The pricing message summary.",
"type":"string"
},
"identifier":{
"description":"The pricing message identifier.",
"type":"string"
},
"priority":{
"description":"The pricing message priority.",
"type":"integer"
},
"params":{
"description":"The list of all message parameters.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"type":{
"description":"The pricing message type.",
"type":"string"
}
}
}
}
}
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shoppingCart":{
"description":"The shopping cart contents of the current order.",
"type":"object",
"properties":{
"items":{
"description":"The array of products in the shopping cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"childItems":{
"description":"The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (externally configured) or not (externally configured).",
"type":"boolean"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name 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"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"amount":{
"description":"The total amount of this item including its child items amounts.",
"type":"number"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"skuid of the item.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"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"
},
"itemDiscountInfos":{
"description":"Array of promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by gift with purchase.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseDiscountInfo":{
"description":"The gift information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseChoicesAvailable":{
"description":"If this gift with purchase has multiple gift choices.",
"type":"boolean"
},
"giftWithPurchaseQuantity":{
"description":"The quantity that is gift quantity",
"type":"number"
},
"giftWithPurchaseIdentifier":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
}
}
},
"giftWithPurchaseInfo":{
"description":"The gift information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository ID of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion ID",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"selectedCountry":{
"description":"Country code.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"alias":{
"description":"Address alias.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"selectedState":{
"description":"State code.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
},
"state_ISOCode":{
"description":"State ISO code.",
"type":"string"
}
}
},
"siteId":{
"description":"The ID of the site on which the order was placed.",
"type":"string"
},
"id":{
"description":"The order ID.",
"type":"string"
},
"quoteInfo":{
"description":"the quote information of the order",
"type":"object",
"properties":{
"providerNote":{
"description":"the provider note for the quoted order",
"type":"string"
},
"notes":{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile ID of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
},
"rejectionDate":{
"description":"rejection date of the quoted order",
"type":"string"
},
"requestDate":{
"description":"the date when the quote was requested in ISO format",
"type":"string"
},
"errorInfo":{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
},
"externalId":{
"description":"the external ID for the quote",
"type":"string"
},
"rejectionNote":{
"description":"the rejection note for an order whose quote has been rejected by user",
"type":"string"
},
"quoteDate":{
"description":"the date the order was quoted in milliseconds",
"type":"number"
},
"expirationDate":{
"description":"the expiration date of the quoted order, if any",
"type":"string"
}
}
},
"giftWithPurchaseOrderMarkers":{
"description":"giftWithPurchaseOrderMarker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository ID of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
}
}
}
Nested Schema : approvalSystemMessages
Type: array
An array of approval messages when order going in pending approval state
Show Source
{
"description":"An array of approval messages when order going in pending approval state",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
{
"description":"The discount information.",
"type":"object",
"properties":{
"orderDiscount":{
"description":"The order discount.",
"type":"number"
},
"orderDiscountDescList":{
"description":"The list of all the order discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon code.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"secondaryCurrencyShippingDiscount":{
"description":"The shipping discount in secondary currency in case of mix currency scenario.",
"type":"number"
},
"shippingDiscount":{
"description":"The shipping discount.",
"type":"number"
}
}
}
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
{
"description":"Read-only list of dynamic properties for the order along with meta-data.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
}
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
{
"description":"The gift information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository ID of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion ID",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
}
}
}
}
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information
Show Source
{
"description":"giftWithPurchaseOrderMarker information",
"type":"array",
"items":{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository ID of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
}
Nested Schema : payments
Type: array
Payment details for the order, including additional properties specific to the payment type.
Show Source
{
"description":"Payment details for the order, including additional properties specific to the payment type.",
"type":"array",
"items":{
"type":"object",
"properties":{
"paymentGroupId":{
"description":"Payment group ID.",
"type":"string"
},
"savedCardId":{
"description":"ID of the saved card associated with the payment group.",
"type":"string"
},
"amount":{
"description":"Amount authorized from the payment group.",
"type":"number"
},
"balance":{
"description":"Total available balance on the gift card.",
"type":"number"
},
"gatewayName":{
"description":"Payment gateway name. e.g. chaseCreditCard.",
"type":"string"
},
"giftCardNumber":{
"description":"Gift card number.",
"type":"string"
},
"paymentMethod":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
"type":"string"
},
"isAmountRemaining":{
"description":"A boolean to decide if more payment can be made from this payment group.",
"type":"boolean"
},
"paymentState":{
"description":"The state of the payment group. e.g. AUTHORIZED.",
"type":"string"
},
"maskedCardNumber":{
"description":"Masked gift card number.",
"type":"string"
}
}
}
}
Nested Schema : priceInfo
Type: object
The order price information.
Show Source
-
amount(optional):
number
-
currencyCode(optional):
string
-
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
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
-
tax(optional):
number
-
taxExclusiveAmount(optional):
number
Total excluding shipping and tax in monetary currency
-
total(optional):
number
{
"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 : pricingMessages
Type: object
The Pricing messages information.
Show Source
{
"description":"The Pricing messages information.",
"type":"object",
"properties":{
"giftWithPurchaseMessages":{
"description":"The gift with purchase messages information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"summary":{
"description":"The pricing message summary.",
"type":"string"
},
"identifier":{
"description":"The pricing message identifier.",
"type":"string"
},
"priority":{
"description":"The pricing message priority.",
"type":"integer"
},
"params":{
"description":"The list of all message parameters.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"type":{
"description":"The pricing message type.",
"type":"string"
}
}
}
}
}
}
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
{
"description":"the quote information of the order",
"type":"object",
"properties":{
"providerNote":{
"description":"the provider note for the quoted order",
"type":"string"
},
"notes":{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile ID of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
},
"rejectionDate":{
"description":"rejection date of the quoted order",
"type":"string"
},
"requestDate":{
"description":"the date when the quote was requested in ISO format",
"type":"string"
},
"errorInfo":{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
},
"externalId":{
"description":"the external ID for the quote",
"type":"string"
},
"rejectionNote":{
"description":"the rejection note for an order whose quote has been rejected by user",
"type":"string"
},
"quoteDate":{
"description":"the date the order was quoted in milliseconds",
"type":"number"
},
"expirationDate":{
"description":"the expiration date of the quoted order, if any",
"type":"string"
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"selectedCountry":{
"description":"Country code.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"alias":{
"description":"Address alias.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"selectedState":{
"description":"State code.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
},
"state_ISOCode":{
"description":"State ISO code.",
"type":"string"
}
}
}
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
{
"description":"The shipping groups for the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"surcharge":{
"description":"The shipping surcharge.",
"type":"number"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"The shipping tax.",
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"secondaryCurrencyShipingAmount":{
"description":"shipping amount in monetry currency ",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"description":"The description of the shipping method.",
"type":"string"
}
}
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location ID of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The current total shipping amount in monetry currency ",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The current total in loyalty points in case of multi currency",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The current total (sum of shipping and tax)amount in monetry currency",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"Extra handling costs for shipping the products in monetry currency.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products.",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"selectedCountry":{
"description":"Country code.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"alias":{
"description":"Address alias.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"selectedState":{
"description":"State code.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
},
"state_ISOCode":{
"description":"State ISO code.",
"type":"string"
}
}
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceId":{
"description":"Repository ID",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the shipping group.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"active":{
"description":"active or not.",
"type":"boolean"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
}
}
}
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"Shipping tax",
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"secondaryCurrencyShipingAmount":{
"description":"shipping amount in monetry currency ",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
}
}
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order.
Show Source
{
"description":"The shopping cart contents of the current order.",
"type":"object",
"properties":{
"items":{
"description":"The array of products in the shopping cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"childItems":{
"description":"The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (externally configured) or not (externally configured).",
"type":"boolean"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name 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"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"amount":{
"description":"The total amount of this item including its child items amounts.",
"type":"number"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"skuid of the item.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"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"
},
"itemDiscountInfos":{
"description":"Array of promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by gift with purchase.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseDiscountInfo":{
"description":"The gift information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseChoicesAvailable":{
"description":"If this gift with purchase has multiple gift choices.",
"type":"boolean"
},
"giftWithPurchaseQuantity":{
"description":"The quantity that is gift quantity",
"type":"number"
},
"giftWithPurchaseIdentifier":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
}
}
}
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
}
Nested Schema : orderDiscountDescList
Type: array
The list of all the order discounts.
Show Source
{
"description":"The list of all the order discounts.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon code.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon code.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"giftWithPurchaseQuantityAvailableForSelection":{
"description":"gift quantity available for selection",
"type":"number"
},
"giftWithPurchaseType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"giftWithPurchaseDetail":{
"description":"String identifying the free gift, usually the repository ID of the gift type.",
"type":"string"
},
"promotionId":{
"description":"The gift with purchase promotion ID",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"quantity":{
"description":"The total quantity of sku for this gift selection.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.",
"type":"integer"
},
"removedQuantity":{
"description":"The amount of free quantity that has since been manually removed by a Shopper.",
"type":"number"
},
"data":{
"description":"An identifier used to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.",
"type":"integer"
},
"autoRemove":{
"description":"Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.",
"type":"boolean"
},
"giftDetail":{
"description":"String identifying the free gift, usually the repository ID of the gift type.",
"type":"string"
},
"automaticQuantity":{
"description":"The quantity of free sku for this gift selection that has already been auto added to the order.",
"type":"number"
},
"giftType":{
"description":"The type of the gift. (sku, product)",
"type":"string"
},
"failedQuantity":{
"description":"The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"paymentGroupId":{
"description":"Payment group ID.",
"type":"string"
},
"savedCardId":{
"description":"ID of the saved card associated with the payment group.",
"type":"string"
},
"amount":{
"description":"Amount authorized from the payment group.",
"type":"number"
},
"balance":{
"description":"Total available balance on the gift card.",
"type":"number"
},
"gatewayName":{
"description":"Payment gateway name. e.g. chaseCreditCard.",
"type":"string"
},
"giftCardNumber":{
"description":"Gift card number.",
"type":"string"
},
"paymentMethod":{
"description":"Payment method. e.g. physicalGiftCard/ creditCard.",
"type":"string"
},
"uiIntervention":{
"description":"This decides whether the client has to do some intervention for payment. e.g. SOP.",
"type":"string"
},
"isAmountRemaining":{
"description":"A boolean to decide if more payment can be made from this payment group.",
"type":"boolean"
},
"paymentState":{
"description":"The state of the payment group. e.g. AUTHORIZED.",
"type":"string"
},
"maskedCardNumber":{
"description":"Masked gift card number.",
"type":"string"
}
}
}
Nested Schema : giftWithPurchaseMessages
Type: array
The gift with purchase messages information.
Show Source
{
"description":"The gift with purchase messages information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"summary":{
"description":"The pricing message summary.",
"type":"string"
},
"identifier":{
"description":"The pricing message identifier.",
"type":"string"
},
"priority":{
"description":"The pricing message priority.",
"type":"integer"
},
"params":{
"description":"The list of all message parameters.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"type":{
"description":"The pricing message type.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"summary":{
"description":"The pricing message summary.",
"type":"string"
},
"identifier":{
"description":"The pricing message identifier.",
"type":"string"
},
"priority":{
"description":"The pricing message priority.",
"type":"integer"
},
"params":{
"description":"The list of all message parameters.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"type":{
"description":"The pricing message type.",
"type":"string"
}
}
}
Nested Schema : params
Type: array
The list of all message parameters.
Show Source
{
"description":"The list of all message parameters.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
Nested Schema : errorInfo
Type: array
the array of errors, if any
Show Source
{
"description":"the array of errors, if any",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : notes
Type: array
the notes (history) for the order
Show Source
{
"description":"the notes (history) for the order",
"type":"array",
"items":{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile ID of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"requestDate/quoteDate/rejectionDate":{
"description":"the request/quote/rejection date for the note",
"type":"number"
},
"profileType":{
"description":"the profile type of the user that requested the quote",
"type":"string"
},
"profileId":{
"description":"the profile ID of the user",
"type":"string"
},
"requesterNote/providerNote/rejectionNote":{
"description":"the requester/provider/rejection note",
"type":"string"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"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: object
Show Source
{
"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: object
Show Source
{
"type":"object",
"properties":{
"surcharge":{
"description":"The shipping surcharge.",
"type":"number"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"The shipping tax.",
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"secondaryCurrencyShipingAmount":{
"description":"shipping amount in monetry currency ",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"description":"The description of the shipping method.",
"type":"string"
}
}
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location ID of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"priceInfo":{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The current total shipping amount in monetry currency ",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The current total in loyalty points in case of multi currency",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The current total (sum of shipping and tax)amount in monetry currency",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"Extra handling costs for shipping the products in monetry currency.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products.",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
},
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"recurringChargePriceInfo":{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingInfo":{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
},
"shippingAddress":{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"selectedCountry":{
"description":"Country code.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"alias":{
"description":"Address alias.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"selectedState":{
"description":"State code.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
},
"state_ISOCode":{
"description":"State ISO code.",
"type":"string"
}
}
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"trackingNumber":{
"description":"The tracking number.",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceId":{
"description":"Repository ID",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the shipping group.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"active":{
"description":"active or not.",
"type":"boolean"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
}
}
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceId":{
"description":"Repository ID",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the shipping group.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"active":{
"description":"active or not.",
"type":"boolean"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
}
Nested Schema : priceInfo
Type: object
The price information.
Show Source
{
"description":"The price information.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"amount":{
"description":"The total order amount.",
"type":"number"
},
"total":{
"description":"The order total.",
"type":"number"
},
"secondaryCurrencyShippingAmount":{
"description":"The current total shipping amount in monetry currency ",
"type":"number"
},
"shipping":{
"description":"The total shipping cost.",
"type":"number"
},
"primaryCurrencyTotal":{
"description":"The current total in loyalty points in case of multi currency",
"type":"number"
},
"secondaryCurrencyTotal":{
"description":"The current total (sum of shipping and tax)amount in monetry currency",
"type":"number"
},
"secondaryCurrencyShippingSurchargeValue":{
"description":"Extra handling costs for shipping the products in monetry currency.",
"type":"number"
},
"shippingSurchargeValue":{
"description":"Extra handling costs for shipping the products.",
"type":"number"
},
"tax":{
"description":"The total tax amount.",
"type":"number"
},
"subTotal":{
"description":"Sub-total.",
"type":"number"
},
"currencyCode":{
"description":"The currency code.",
"type":"string"
}
}
}
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
{
"description":"Recurring charge price information.",
"type":"object",
"properties":{
"amount":{
"description":"The monetary amount of this recurring charge.",
"type":"number"
},
"total":{
"description":"The total price of the recurring charge.",
"type":"number"
},
"frequencyAmountTotals":{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
},
"shipping":{
"description":"Cost of shipping the product.",
"type":"number"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"subTotal":{
"description":"The sub-total price of the recurring charge.",
"type":"number"
},
"frequencyTaxTotals":{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
},
"currencyCode":{
"description":"The currency code for the monetary amounts. A three character currency code such as USD.",
"type":"string"
},
"totalWithoutTax":{
"description":"Total of recurring amount without tax included.",
"type":"number"
}
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
{
"description":"The shipping address details.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name.",
"type":"string"
},
"country":{
"description":"Country.",
"type":"string"
},
"address3":{
"description":"Address snippet.",
"type":"string"
},
"address2":{
"description":"Address snippet.",
"type":"string"
},
"city":{
"description":"City.",
"type":"string"
},
"prefix":{
"description":"Name prefix.",
"type":"string"
},
"address1":{
"description":"Address snippet.",
"type":"string"
},
"postalCode":{
"description":"Postal code.",
"type":"string"
},
"jobTitle":{
"description":"Job title.",
"type":"string"
},
"companyName":{
"description":"Company name.",
"type":"string"
},
"county":{
"description":"County.",
"type":"string"
},
"suffix":{
"description":"Name suffix.",
"type":"string"
},
"selectedCountry":{
"description":"Country code.",
"type":"string"
},
"firstName":{
"description":"First name",
"type":"string"
},
"phoneNumber":{
"description":"Phone number.",
"type":"string"
},
"alias":{
"description":"Address alias.",
"type":"string"
},
"faxNumber":{
"description":"Fax number.",
"type":"string"
},
"middleName":{
"description":"Middle name.",
"type":"string"
},
"state":{
"description":"State.",
"type":"string"
},
"selectedState":{
"description":"State code.",
"type":"string"
},
"email":{
"description":"Email address.",
"type":"string"
},
"state_ISOCode":{
"description":"State ISO code.",
"type":"string"
}
}
}
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"secondaryCurrencyTaxAmount":{
"description":"Shipping tax amount in monetry currency",
"type":"number"
},
"shippingTax":{
"description":"The shipping tax.",
"type":"number"
},
"cost":{
"description":"The total cost of shipping.",
"type":"number"
},
"secondaryCurrencyShipingAmount":{
"description":"shipping amount in monetry currency ",
"type":"number"
},
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
},
"shippingMethodDescription":{
"description":"The description of the shipping method.",
"type":"string"
}
}
}
Nested Schema : store
Type: object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location ID of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
}
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
{
"description":"Tracking Information for the Order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"availablePickupDate":{
"description":"The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name of the product.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"commerceId":{
"description":"Repository ID",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the shipping group.",
"type":"integer"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"relationshipType":{
"description":"The type of this relationship. SHIPPINGQUANITY or SHIPPINGQUANTITYREMAINING.",
"type":"string"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"active":{
"description":"active or not.",
"type":"boolean"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"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 : discountInfo
Type: array
The discount information.
Show Source
{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
}
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
}
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
}
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
}
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
{
"description":"The total for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"total":{
"description":"The total amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's total e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
{
"description":"The tax for each recurring charge frequency",
"type":"array",
"items":{
"type":"object",
"properties":{
"tax":{
"description":"The tax amount for the frequency.",
"type":"string"
},
"frequency":{
"description":"The frequency for the item's tax e.g. Monthly.",
"type":"string"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"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: object
Show Source
{
"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: object
Show Source
{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}
Nested Schema : items
Type: array
The array of products in the shopping cart.
Show Source
{
"description":"The array of products in the shopping cart.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"childItems":{
"description":"The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (externally configured) or not (externally configured).",
"type":"boolean"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name 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"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"amount":{
"description":"The total amount of this item including its child items amounts.",
"type":"number"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"skuid of the item.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"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"
},
"itemDiscountInfos":{
"description":"Array of promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by gift with purchase.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseDiscountInfo":{
"description":"The gift information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseChoicesAvailable":{
"description":"If this gift with purchase has multiple gift choices.",
"type":"boolean"
},
"giftWithPurchaseQuantity":{
"description":"The quantity that is gift quantity",
"type":"number"
},
"giftWithPurchaseIdentifier":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"dynamicProperties":{
"description":"Array of custom properties at order line item level.",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"The ID of the dynamic property.",
"type":"string"
},
"label":{
"description":"The label of the dynamic property.",
"type":"string"
},
"value":{
"description":"The value of the dynamic property. The value type depends on how the dynamic property was defined and might be something other than string, such as boolean or number.",
"type":"string"
}
}
}
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"childItems":{
"description":"The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (externally configured) or not (externally configured).",
"type":"boolean"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name 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"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"amount":{
"description":"The total amount of this item including its child items amounts.",
"type":"number"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"skuid of the item.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
},
"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"
},
"itemDiscountInfos":{
"description":"Array of promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the item promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"commerceItemId":{
"description":"The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no or when an externally configurable item is not sold as package.",
"type":"string"
},
"price":{
"description":"The actual price of the product.",
"type":"number"
},
"variant":{
"description":"List of variants for the product.",
"type":"array",
"items":{
"type":"object",
"properties":{
"optionValue":{
"description":"The variant option value.",
"type":"string"
},
"optionName":{
"description":"The variant option name.",
"type":"string"
}
}
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"pointOfNoRevision":{
"description":"The boolean that indicates if the item has passed pointOfNoRevision.",
"type":"boolean"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"orderDiscountInfos":{
"description":"Array of order promotions received by this item.",
"type":"array",
"items":{
"type":"object",
"properties":{
"couponCodes":{
"description":"One or more coupon codes used to grant the order promotion providing the discount.",
"type":"array",
"items":{
"type":"string"
}
},
"amount":{
"description":"The amount of discount this item received from the promotion.",
"type":"number"
},
"promotionId":{
"description":"The promotion ID that resulted in the discount.",
"type":"string"
}
}
}
},
"giftWithPurchaseCommerceItemMarkers":{
"description":"The array of giftWithPurchaseCommerceItemMarkers.",
"type":"array",
"items":{
"type":"object",
"properties":{
"remainingQuantity":{
"description":"The quantity of the commerce item that is not affected by gift with purchase.",
"type":"number"
},
"selectedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was selected by the shopper.",
"type":"number"
},
"data":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
},
"automaticQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was auto added by pricing.",
"type":"number"
},
"value":{
"description":"The gift with purchase promotion ID.",
"type":"string"
},
"targetedQuantity":{
"description":"The quantity of the free gift that this commerce item is making free and was targeted by pricing.",
"type":"number"
},
"key":{
"description":"atg.gwp",
"type":"string"
}
}
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
},
"skuProperties":{
"description":"Sku properties Information",
"type":"array",
"items":{
"type":"object",
"properties":{
"propertyType":{
"description":"Type that indicates whether it is a base or a custom SKU property,",
"type":"string"
},
"name":{
"description":"Name of the Dynamic SKU Property.",
"type":"string"
},
"id":{
"description":"ID of the Dynamic SKU Property.",
"type":"string"
},
"value":{
"description":"Value of the Dynamic SKU Property.",
"type":"string"
}
}
}
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"discountInfo":{
"description":"The discount information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"promotionLongDesc":{
"description":"The description of the promotion.",
"type":"string"
},
"promotionName":{
"description":"The display name of the promotion.",
"type":"string"
},
"external":{
"description":"States whether this promotion was applied by an external system (only present on external promotions).",
"type":"boolean"
},
"promotionLevel":{
"description":"The promotion level.",
"type":"string"
},
"coupon":{
"description":"The coupon ID.",
"type":"string"
},
"totalAdjustment":{
"description":"Total adjustment by the promotion.",
"type":"number"
},
"promotionDesc":{
"description":"Description of the promotion. Retained for backward compatibility.",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseDiscountInfo":{
"description":"The gift information.",
"type":"array",
"items":{
"type":"object",
"properties":{
"giftWithPurchaseChoicesAvailable":{
"description":"If this gift with purchase has multiple gift choices.",
"type":"boolean"
},
"giftWithPurchaseQuantity":{
"description":"The quantity that is gift quantity",
"type":"number"
},
"giftWithPurchaseIdentifier":{
"description":"The gift hash code for this gift with purchase promotion.",
"type":"integer"
}
}
}
}
}
}
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.
Show Source
{
"description":"The array of child items in the item, if the item is a configurable item. If a child item is itself configurable, it can contain its own childItems array. Specifying a childItems array, even if empty, will permit new children or layers of descendants to be added in subsequent update operations.",
"type":"array",
"items":{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (externally configured) or not (externally configured).",
"type":"boolean"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name 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"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"amount":{
"description":"The total amount of this item including its child items amounts.",
"type":"number"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"skuid of the item.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the child item is an add-on (externally configured) or not (externally configured).",
"type":"boolean"
},
"rawTotalPrice":{
"description":"The raw price of the product.",
"type":"number"
},
"displayName":{
"description":"The name 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"
}
}
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
}
}
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"type":"string"
},
"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"
},
"externalPrice":{
"description":"A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).",
"type":"number"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"id":{
"description":"Repository ID of the commerce item.",
"type":"string"
},
"state":{
"description":"state of the commerce Item",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"unitPrice":{
"description":"The unit price of the product.",
"type":"number"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this item.",
"type":"string"
},
"amount":{
"description":"The total amount of this item including its child items amounts.",
"type":"number"
},
"quantity":{
"description":"The quantity of the product.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"externalPriceQuantity":{
"description":"The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).",
"type":"integer"
},
"externalRecurringChargeFrequency":{
"description":"The frequency for the recurring charge e.g. Monthly.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"skuid of the item.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"siteId":{
"description":"The ID of the site on which the item was added.",
"type":"string"
},
"detailedRecurringChargeInfo":{
"description":"Detailed Item Price Information.",
"type":"object",
"properties":{
"discounted":{
"description":"Whether the price is discounted.",
"type":"boolean"
},
"amount":{
"description":"The monetary amount for the recurring charge.",
"type":"number"
},
"quantity":{
"description":"The number of items covered by this recurring charge price info",
"type":"integer"
},
"tax":{
"description":"Monetary tax amount.",
"type":"number"
},
"orderDiscountShare":{
"description":"The order Discount Share.",
"type":"number"
},
"detailedUnitPrice":{
"description":"The detailed unit price: amount / quantity. (read-only)",
"type":"number"
},
"currencyCode":{
"description":"The three character currency code for the monetary amounts.",
"type":"string"
}
}
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"carrierName":{
"description":"Carrier Name for Tracking.",
"type":"string"
},
"carrierUrl":{
"description":"Carrier URL for Tracking.",
"type":"string"
},
"carrierId":{
"description":"Carrier ID for Tracking.",
"type":"string"
},
"trackingNumber":{
"description":"Tracking Number.",
"type":"string"
}
}
}