Root Schema : requestQuote_request
Type: object
Show Source
{
"properties":{
"note":{
"description":"The requester note supplied with the quote request",
"type":"string"
},
"combineLineItems":{
"description":"Value to determine if line items are to be combined. Can be yes or no.",
"type":"string"
},
"shippingGroups":{
"description":"The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"locationId":{
"description":"The location ID of the store from which items are to be picked up (if type is inStorePickupShippingGroup).",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
},
"required":[
"value"
]
},
"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"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"selectedCountry",
"firstName",
"state",
"selectedState",
"email",
"state_ISOCode"
]
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"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"
},
"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"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in this shipping group.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
},
"required":[
"shippingAddress - required if a hardgood shipping group is desired",
"shippingMethod - required if a hardgood shipping group is desired",
"items"
]
}
},
"orderId":{
"description":"The order ID for the order which is to be quoted. If undefined, the current incomplete order for profile is selected",
"type":"string"
},
"appliedPromotions":{
"description":"The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.",
"type":"array",
"items":{
"type":"string"
}
},
"shippingMethod":{
"description":"The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.",
"type":"object",
"properties":{
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
},
"required":[
"value"
]
},
"shoppingCart":{
"description":"The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.",
"type":"object",
"properties":{
"coupons":{
"description":"The array of coupons applied to the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"code":{
"description":"The coupon code.",
"type":"string"
},
"level":{
"description":"The level of the coupon (whether the coupon is item level, etc).",
"type":"string"
},
"description":{
"description":"The coupon description.",
"type":"string"
},
"id":{
"description":"The coupon ID.",
"type":"string"
},
"status":{
"description":"The current status of the coupon.",
"type":"string"
}
},
"required":[
"code",
"level",
"id",
"status"
]
}
},
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"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. A child item can itself contain a child item array if it is a configurable product in itself.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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). The value of this property should be -1 in case if the current item is a sub item of a configurable product ",
"type":"integer"
},
"rootAssetKey":{
"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":"Sku reference ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
},
"required":[
"quantity",
"productId",
"catRefId",
"externalPrice",
"externalPriceQuantity"
]
}
},
"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"
},
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"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"
},
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"giftWithPurchaseSelections":{
"description":"The array of gift with purchase selections to be made.",
"type":"array",
"items":{
"type":"object",
"properties":{
"productId":{
"description":"ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"giftWithPurchaseQuantity":{
"description":"The total quantity of the commerceItem that is giftWithPurchaseQuantity.",
"type":"integer"
},
"catRefId":{
"description":"The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"The identifier that links this gift with purchase to the giftWithPurchaseInfo.",
"type":"integer"
}
},
"required":[
"giftWithPurchaseQuantity",
"promotionId",
"giftWithPurchaseIdentifier"
]
}
},
"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"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"orderTotal":{
"description":"The total price of the order.",
"type":"number"
}
},
"required":[
"items"
]
},
"shippingAddress":{
"description":"The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.",
"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"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"selectedCountry",
"firstName",
"state",
"selectedState",
"email",
"state_ISOCode"
]
}
},
"example":{
"note":"This is a sample quote request"
}
}
Example:
{
"note":"This is a sample quote request"
}
Nested Schema : appliedPromotions
Type: array
The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.
Show Source
{
"description":"The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : shippingAddress
Type: object
The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.
Show Source
{
"description":"The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.",
"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"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"selectedCountry",
"firstName",
"state",
"selectedState",
"email",
"state_ISOCode"
]
}
Nested Schema : shippingGroups
Type: array
The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.
Show Source
{
"description":"The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"locationId":{
"description":"The location ID of the store from which items are to be picked up (if type is inStorePickupShippingGroup).",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
},
"required":[
"value"
]
},
"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"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"selectedCountry",
"firstName",
"state",
"selectedState",
"email",
"state_ISOCode"
]
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"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"
},
"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"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in this shipping group.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
},
"required":[
"shippingAddress - required if a hardgood shipping group is desired",
"shippingMethod - required if a hardgood shipping group is desired",
"items"
]
}
}
Nested Schema : shippingMethod
Type: object
The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.
Show Source
{
"description":"The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.",
"type":"object",
"properties":{
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
},
"required":[
"value"
]
}
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.
Show Source
{
"description":"The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.",
"type":"object",
"properties":{
"coupons":{
"description":"The array of coupons applied to the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"code":{
"description":"The coupon code.",
"type":"string"
},
"level":{
"description":"The level of the coupon (whether the coupon is item level, etc).",
"type":"string"
},
"description":{
"description":"The coupon description.",
"type":"string"
},
"id":{
"description":"The coupon ID.",
"type":"string"
},
"status":{
"description":"The current status of the coupon.",
"type":"string"
}
},
"required":[
"code",
"level",
"id",
"status"
]
}
},
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"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. A child item can itself contain a child item array if it is a configurable product in itself.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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). The value of this property should be -1 in case if the current item is a sub item of a configurable product ",
"type":"integer"
},
"rootAssetKey":{
"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":"Sku reference ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
},
"required":[
"quantity",
"productId",
"catRefId",
"externalPrice",
"externalPriceQuantity"
]
}
},
"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"
},
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"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"
},
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"giftWithPurchaseSelections":{
"description":"The array of gift with purchase selections to be made.",
"type":"array",
"items":{
"type":"object",
"properties":{
"productId":{
"description":"ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"giftWithPurchaseQuantity":{
"description":"The total quantity of the commerceItem that is giftWithPurchaseQuantity.",
"type":"integer"
},
"catRefId":{
"description":"The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"The identifier that links this gift with purchase to the giftWithPurchaseInfo.",
"type":"integer"
}
},
"required":[
"giftWithPurchaseQuantity",
"promotionId",
"giftWithPurchaseIdentifier"
]
}
},
"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"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"orderTotal":{
"description":"The total price of the order.",
"type":"number"
}
},
"required":[
"items"
]
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"firstName":{
"description":"The first name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"lastName":{
"description":"The last name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"locationId":{
"description":"The location ID of the store from which items are to be picked up (if type is inStorePickupShippingGroup).",
"type":"string"
},
"shippingMethod":{
"description":"The shipping method details for the order.",
"type":"object",
"properties":{
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
},
"required":[
"value"
]
},
"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"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"selectedCountry",
"firstName",
"state",
"selectedState",
"email",
"state_ISOCode"
]
},
"middleName":{
"description":"The middle name of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"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"
},
"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"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in this shipping group.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"email":{
"description":"The email address of the person picking up the items in store (if type is inStorePickupShippingGroup).",
"type":"string"
}
},
"required":[
"shippingAddress - required if a hardgood shipping group is desired",
"shippingMethod - required if a hardgood shipping group is desired",
"items"
]
}
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":{
"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"
},
"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"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in this shipping group.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
}
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"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"selectedCountry",
"firstName",
"state",
"selectedState",
"email",
"state_ISOCode"
]
}
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":{
"value":{
"description":"The shipping method applied to the order.",
"type":"string"
}
},
"required":[
"value"
]
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"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"
},
"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"
},
"inventoryLocationId":{
"description":"Defines the inventory location that services the referenced commerce item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in this shipping group.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"preferredPickupDate":{
"description":"The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).",
"type":"string"
},
"catRefId":{
"description":"The product variant ID.",
"type":"string"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
Nested Schema : coupons
Type: array
The array of coupons applied to the order.
Show Source
{
"description":"The array of coupons applied to the order.",
"type":"array",
"items":{
"type":"object",
"properties":{
"code":{
"description":"The coupon code.",
"type":"string"
},
"level":{
"description":"The level of the coupon (whether the coupon is item level, etc).",
"type":"string"
},
"description":{
"description":"The coupon description.",
"type":"string"
},
"id":{
"description":"The coupon ID.",
"type":"string"
},
"status":{
"description":"The current status of the coupon.",
"type":"string"
}
},
"required":[
"code",
"level",
"id",
"status"
]
}
}
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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"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. A child item can itself contain a child item array if it is a configurable product in itself.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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). The value of this property should be -1 in case if the current item is a sub item of a configurable product ",
"type":"integer"
},
"rootAssetKey":{
"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":"Sku reference ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
},
"required":[
"quantity",
"productId",
"catRefId",
"externalPrice",
"externalPriceQuantity"
]
}
},
"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"
},
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"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"
},
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"giftWithPurchaseSelections":{
"description":"The array of gift with purchase selections to be made.",
"type":"array",
"items":{
"type":"object",
"properties":{
"productId":{
"description":"ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"giftWithPurchaseQuantity":{
"description":"The total quantity of the commerceItem that is giftWithPurchaseQuantity.",
"type":"integer"
},
"catRefId":{
"description":"The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"The identifier that links this gift with purchase to the giftWithPurchaseInfo.",
"type":"integer"
}
},
"required":[
"giftWithPurchaseQuantity",
"promotionId",
"giftWithPurchaseIdentifier"
]
}
},
"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"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"code":{
"description":"The coupon code.",
"type":"string"
},
"level":{
"description":"The level of the coupon (whether the coupon is item level, etc).",
"type":"string"
},
"description":{
"description":"The coupon description.",
"type":"string"
},
"id":{
"description":"The coupon ID.",
"type":"string"
},
"status":{
"description":"The current status of the coupon.",
"type":"string"
}
},
"required":[
"code",
"level",
"id",
"status"
]
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"billingProfileId":{
"description":"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. A child item can itself contain a child item array if it is a configurable product in itself.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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). The value of this property should be -1 in case if the current item is a sub item of a configurable product ",
"type":"integer"
},
"rootAssetKey":{
"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":"Sku reference ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
},
"required":[
"quantity",
"productId",
"catRefId",
"externalPrice",
"externalPriceQuantity"
]
}
},
"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"
},
"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"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"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"
},
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"giftWithPurchaseSelections":{
"description":"The array of gift with purchase selections to be made.",
"type":"array",
"items":{
"type":"object",
"properties":{
"productId":{
"description":"ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"giftWithPurchaseQuantity":{
"description":"The total quantity of the commerceItem that is giftWithPurchaseQuantity.",
"type":"integer"
},
"catRefId":{
"description":"The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"The identifier that links this gift with purchase to the giftWithPurchaseInfo.",
"type":"integer"
}
},
"required":[
"giftWithPurchaseQuantity",
"promotionId",
"giftWithPurchaseIdentifier"
]
}
},
"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"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
{
"description":"The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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). The value of this property should be -1 in case if the current item is a sub item of a configurable product ",
"type":"integer"
},
"rootAssetKey":{
"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":"Sku reference ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
},
"required":[
"quantity",
"productId",
"catRefId",
"externalPrice",
"externalPriceQuantity"
]
}
}
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 : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}
Nested Schema : giftWithPurchaseSelections
Type: array
The array of gift with purchase selections to be made.
Show Source
{
"description":"The array of gift with purchase selections to be made.",
"type":"array",
"items":{
"type":"object",
"properties":{
"productId":{
"description":"ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"giftWithPurchaseQuantity":{
"description":"The total quantity of the commerceItem that is giftWithPurchaseQuantity.",
"type":"integer"
},
"catRefId":{
"description":"The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"The identifier that links this gift with purchase to the giftWithPurchaseInfo.",
"type":"integer"
}
},
"required":[
"giftWithPurchaseQuantity",
"promotionId",
"giftWithPurchaseIdentifier"
]
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"The quantity of the product in the cart.",
"type":"integer"
},
"productId":{
"description":"ID of the product in the cart.",
"type":"string"
},
"externalRecurringCharge":{
"description":"The external recurring price.",
"type":"number"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
},
"parentAssetKey":{
"description":"The parentAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"billingProfileId":{
"description":"The billing profile ID associated to the current item.",
"type":"string"
},
"billingAccountId":{
"description":"The billing account ID associated to the current item.",
"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). The value of this property should be -1 in case if the current item is a sub item of a configurable product ",
"type":"integer"
},
"rootAssetKey":{
"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":"Sku reference ID.",
"type":"string"
},
"externalRecurringChargeDuration":{
"description":"The duration for the recurring charge e.g. 12 months.",
"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"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"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"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
},
"recurringCharge":{
"description":"The recurring charge for the item.",
"type":"number"
}
},
"required":[
"quantity",
"productId",
"catRefId",
"externalPrice",
"externalPriceQuantity"
]
}
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 : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
}
Nested Schema : 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}
Nested Schema : 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"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the externalData item by the configurator system.",
"type":"string"
}
},
"required":[
"values",
"name"
]
}
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"productId":{
"description":"ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"giftWithPurchaseQuantity":{
"description":"The total quantity of the commerceItem that is giftWithPurchaseQuantity.",
"type":"integer"
},
"catRefId":{
"description":"The product variant ID. Include this ID when you are wishing to mark this as a gift with purchase selection you wish to change out",
"type":"string"
},
"promotionId":{
"description":"The promotion ID.",
"type":"string"
},
"giftWithPurchaseIdentifier":{
"description":"The identifier that links this gift with purchase to the giftWithPurchaseInfo.",
"type":"integer"
}
},
"required":[
"giftWithPurchaseQuantity",
"promotionId",
"giftWithPurchaseIdentifier"
]
}