Root Schema : requestQuote_request
Type: object
Show Source
{
"properties":{
"note":{
"description":"the requester note supplied with the quote request",
"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"
},
"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"
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"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":[
"shippingMethod",
"shippingAddress",
"items"
]
}
},
"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"
]
},
"payments":{
"description":"List of payments",
"type":"array",
"items":{
"type":"object",
"properties":{
"cardCVV":{
"description":"credit card CVV.",
"type":"string"
},
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"Payment Group Id of the gift card payment group. Payment type: physicalGiftCard",
"type":"string"
},
"nameOnCard":{
"description":"name printed on credit card.",
"type":"string"
},
"giftCardNumber":{
"description":"Gift card number used for payment. Payment type: physicalGiftCard(this field should be used when giftcards are used)",
"type":"string"
},
"cardType":{
"description":"credit card type.",
"type":"string"
},
"giftCardPin":{
"description":"Gift card pin. Payment type: physicalGiftCard(this field should be used when giftcards are used)",
"type":"string"
},
"endMonth":{
"description":"credit card expiry month.",
"type":"string"
},
"type":{
"description":"payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard",
"type":"string"
},
"endYear":{
"description":"credit card expiry year.",
"type":"integer"
},
"cardNumber":{
"description":"credit card number.",
"type":"string"
}
},
"required":[
"cardCVV",
"nameOnCard",
"cardType",
"endMonth",
"type",
"endYear",
"cardNumber"
]
}
},
"submissionProgress":{
"description":"Checkpoints crossed successfully during each unsuccessful retry of queued orders.",
"type":"array",
"items":{
"type":"string"
}
},
"submissionErrorCodes":{
"description":"Set of error codes recorded during each unsuccessful retry of queued orders.",
"type":"array",
"items":{
"type":"string"
}
},
"submissionErrorMessages":{
"description":"List of failure reasons recorded during each unsuccessful retry of queued orders.",
"type":"array",
"items":{
"type":"string"
}
},
"profileId":{
"description":"Profile id.",
"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"
}
},
"amountRemaining":{
"description":"amount to authorize.",
"type":"number"
},
"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":{
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"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"
]
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"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"
},
"isDefaultAddress":{
"description":"Is the Address is used as default address or not.",
"type":"boolean"
},
"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"
]
},
"id":{
"description":"the order id for the order which is to be quoted. If undefined, the current incomplete order for profile is selected",
"type":"string"
},
"billingAddress":{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Is the Address is used as default address or not.",
"type":"boolean"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"firstName",
"state"
]
},
"requestChannel":{
"description":"request Channel name. Possible values are 'agent' or 'asa'.",
"type":"string"
}
},
"required":[
"profileId",
"id"
],
"example":{
"note":"Sample Quote",
"shippingGroups":[
{
"shippingMethod":{
"value":"standardShippingMethod"
},
"shippingAddress":{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com",
"state_ISOCode":"US-NY"
},
"items":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"Product_18Cxi",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"Sku_18Dxi",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
]
}
],
"appliedPromotions":[
],
"profileId":"se-570031",
"payments":[
{
"cardCVV":"service",
"amount":"43.19",
"cardType":"",
"type":"card",
"cardNumber":"service"
}
],
"amountRemaining":"43.19",
"shoppingCart":{
"coupons":[
],
"items":[
{
"quantity":1,
"productId":"Product_18Cxi",
"catRefId":"Sku_18Dxi"
}
],
"orderTotal":43.19
},
"id":"o90419",
"billingAddress":{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com",
"state_ISOCode":"US-NY"
},
"requestChannel":"agent"
}
}
Example:
{
"note":"Sample Quote",
"shippingGroups":[
{
"shippingMethod":{
"value":"standardShippingMethod"
},
"shippingAddress":{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com",
"state_ISOCode":"US-NY"
},
"items":[
{
"serviceAccountId":"serviceAcc-123",
"deactivationDate":"2018-06-27T12:59:59Z",
"quantity":1,
"productId":"Product_18Cxi",
"externalData":[
],
"parentAssetKey":null,
"billingProfileId":"billingProfile-123",
"billingAccountId":"billingAcc-123",
"rootAssetKey":null,
"transactionDate":"2018-06-27T12:59:59Z",
"catRefId":"Sku_18Dxi",
"assetKey":"12345",
"customerAccountId":"customerAcc-123",
"actionCode":"Add",
"activationDate":"2017-06-27T15:30:00Z",
"serviceId":"service-123",
"asset":false
}
]
}
],
"appliedPromotions":[
],
"profileId":"se-570031",
"payments":[
{
"cardCVV":"service",
"amount":"43.19",
"cardType":"",
"type":"card",
"cardNumber":"service"
}
],
"amountRemaining":"43.19",
"shoppingCart":{
"coupons":[
],
"items":[
{
"quantity":1,
"productId":"Product_18Cxi",
"catRefId":"Sku_18Dxi"
}
],
"orderTotal":43.19
},
"id":"o90419",
"billingAddress":{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"email":"kim@example.com",
"state_ISOCode":"US-NY"
},
"requestChannel":"agent"
}
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 : billingAddress
Type: object
Billing address for the order.
Show Source
{
"description":"Billing address for the order.",
"type":"object",
"properties":{
"lastName":{
"description":"Last name for this billing address.",
"type":"string"
},
"country":{
"description":"Country for this billing address.",
"type":"string"
},
"address3":{
"description":"Address line 3 for this billing address.",
"type":"string"
},
"address2":{
"description":"Address line 2 for this billing address.",
"type":"string"
},
"city":{
"description":"City for this billing address.",
"type":"string"
},
"address1":{
"description":"Address line 1 for this billing address.",
"type":"string"
},
"prefix":{
"description":"Prefix for this billing address.",
"type":"string"
},
"companyName":{
"description":"Company name for this billing address.",
"type":"string"
},
"postalCode":{
"description":"Postal code for this billing address.",
"type":"string"
},
"jobTitle":{
"description":"Job title for this billing address.",
"type":"string"
},
"county":{
"description":"County for this billing address.",
"type":"string"
},
"isDefaultAddress":{
"description":"Is the Address is used as default address or not.",
"type":"boolean"
},
"suffix":{
"description":"Suffix for this billing address.",
"type":"string"
},
"selectedCountry":{
"description":"The selected country of the shipping address.",
"type":"string"
},
"firstName":{
"description":"First name for this billing address.",
"type":"string"
},
"phoneNumber":{
"description":"Phone number for this billing address.",
"type":"string"
},
"faxNumber":{
"description":"Fax number for this billing address.",
"type":"string"
},
"middleName":{
"description":"Middle name for this billing address.",
"type":"string"
},
"state":{
"description":"State for this billing address.",
"type":"string"
},
"email":{
"description":"Email for this billing address.",
"type":"string"
},
"selectedState":{
"description":"The selected state of the shipping address.",
"type":"string"
},
"state_ISOCode":{
"description":"The state ISO code of the shipping address.",
"type":"string"
}
},
"required":[
"lastName",
"country",
"city",
"address1",
"postalCode",
"firstName",
"state"
]
}
Nested Schema : payments
Type: array
List of payments
Show Source
{
"description":"List of payments",
"type":"array",
"items":{
"type":"object",
"properties":{
"cardCVV":{
"description":"credit card CVV.",
"type":"string"
},
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"Payment Group Id of the gift card payment group. Payment type: physicalGiftCard",
"type":"string"
},
"nameOnCard":{
"description":"name printed on credit card.",
"type":"string"
},
"giftCardNumber":{
"description":"Gift card number used for payment. Payment type: physicalGiftCard(this field should be used when giftcards are used)",
"type":"string"
},
"cardType":{
"description":"credit card type.",
"type":"string"
},
"giftCardPin":{
"description":"Gift card pin. Payment type: physicalGiftCard(this field should be used when giftcards are used)",
"type":"string"
},
"endMonth":{
"description":"credit card expiry month.",
"type":"string"
},
"type":{
"description":"payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard",
"type":"string"
},
"endYear":{
"description":"credit card expiry year.",
"type":"integer"
},
"cardNumber":{
"description":"credit card number.",
"type":"string"
}
},
"required":[
"cardCVV",
"nameOnCard",
"cardType",
"endMonth",
"type",
"endYear",
"cardNumber"
]
}
}
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"
},
"isDefaultAddress":{
"description":"Is the Address is used as default address or not.",
"type":"boolean"
},
"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"
},
"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"
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"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":[
"shippingMethod",
"shippingAddress",
"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":{
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"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"
]
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"orderTotal":{
"description":"The total price of the order.",
"type":"number"
}
},
"required":[
"items"
]
}
Nested Schema : submissionErrorCodes
Type: array
Set of error codes recorded during each unsuccessful retry of queued orders.
Show Source
{
"description":"Set of error codes recorded during each unsuccessful retry of queued orders.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : submissionErrorMessages
Type: array
List of failure reasons recorded during each unsuccessful retry of queued orders.
Show Source
{
"description":"List of failure reasons recorded during each unsuccessful retry of queued orders.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : submissionProgress
Type: array
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
Show Source
{
"description":"Checkpoints crossed successfully during each unsuccessful retry of queued orders.",
"type":"array",
"items":{
"type":"string"
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"cardCVV":{
"description":"credit card CVV.",
"type":"string"
},
"PONumber":{
"description":"Purchase order number for invoice payment. Payment type: invoice",
"type":"string"
},
"paymentGroupId":{
"description":"Payment Group Id of the gift card payment group. Payment type: physicalGiftCard",
"type":"string"
},
"nameOnCard":{
"description":"name printed on credit card.",
"type":"string"
},
"giftCardNumber":{
"description":"Gift card number used for payment. Payment type: physicalGiftCard(this field should be used when giftcards are used)",
"type":"string"
},
"cardType":{
"description":"credit card type.",
"type":"string"
},
"giftCardPin":{
"description":"Gift card pin. Payment type: physicalGiftCard(this field should be used when giftcards are used)",
"type":"string"
},
"endMonth":{
"description":"credit card expiry month.",
"type":"string"
},
"type":{
"description":"payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard",
"type":"string"
},
"endYear":{
"description":"credit card expiry year.",
"type":"integer"
},
"cardNumber":{
"description":"credit card number.",
"type":"string"
}
},
"required":[
"cardCVV",
"nameOnCard",
"cardType",
"endMonth",
"type",
"endYear",
"cardNumber"
]
}
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"
},
"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"
},
"store":{
"description":"Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)",
"type":"object",
"properties":{
"country":{
"description":"The country in which the store resides.",
"type":"string"
},
"hours":{
"description":"The opening hours of the store.",
"type":"string"
},
"address3":{
"description":"Address line 3 of the store.",
"type":"string"
},
"address2":{
"description":"Address line 2 of the store.",
"type":"string"
},
"city":{
"description":"The city in which the store resides.",
"type":"string"
},
"address1":{
"description":"Address line 1 of the store.",
"type":"string"
},
"postalCode":{
"description":"The postal code of the store.",
"type":"string"
},
"county":{
"description":"The county in which the store resides.",
"type":"string"
},
"stateAddress":{
"description":"The state in which the store resides.",
"type":"string"
},
"phoneNumber":{
"description":"The phone number of the store.",
"type":"string"
},
"locationId":{
"description":"The location id of the store.",
"type":"string"
},
"name":{
"description":"Name of the store.",
"type":"string"
},
"faxNumber":{
"description":"The fax number of the store.",
"type":"string"
},
"email":{
"description":"The email address of the store.",
"type":"string"
}
}
},
"type":{
"description":"The type of shipping group to create, e.g. hardgoodShippingGroup, inStorePickupShippingGroup, inStoreTakeWithShippingGroup, virtualShippingGroup",
"type":"string"
},
"items":{
"description":"The array of products in the shipping group.",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"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":[
"shippingMethod",
"shippingAddress",
"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":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"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 : 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 : items
Type: object
Show Source
{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"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"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
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 : 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":{
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"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"
]
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"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":{
"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"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"The category to which the product belongs.",
"type":"string"
},
"configuratorId":{
"description":"Configuration id of the configurable product",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"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"
},
"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"
]
}
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
}
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"
},
"configurationOptionId":{
"description":"ID of the catalog's configurationOption associated with this sub commerce item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"addOnItem":{
"description":"Whether the sub commerce item is an add-on (internally configured) or not (externally configured).",
"type":"boolean"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"childItems":{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"configurablePropertyId":{
"description":"ID of the catalog's configurableProperty associated with this sub commerce item.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"commerceItemId":{
"description":"commerce item id of the child item ",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"shopperInput":{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
{
"description":"Child items of the commerce item",
"type":"array",
"items":{
"type":"object",
"properties":{
"serviceAccountId":{
"description":"The service account ID associated to the current item.",
"type":"string"
},
"deactivationDate":{
"description":"The deactivation date in ISO format.",
"type":"string"
},
"quantity":{
"description":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
}
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 : shopperInput
Type: object
Additional Properties Allowed
Show Source
{
"description":"Map of shopper input keys to values",
"additionalProperties":{
"type":"string"
},
"type":"object"
}
Map of shopper input keys to values
Nested Schema : items
Type: 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":"Quantity of the child item",
"type":"number"
},
"productId":{
"description":"Product Id of the child item",
"type":"string"
},
"externalData":{
"description":"External data to be associated with a commerce item, provided by a configurator system.",
"type":"array",
"items":{
"type":"object",
"properties":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
},
"rootAssetKey":{
"description":"The rootAssetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"transactionDate":{
"description":"ISO formatted Date on which the service action should be triggered.",
"type":"string"
},
"catRefId":{
"description":"Sku Id of the child item",
"type":"string"
},
"assetKey":{
"description":"The assetKey is only assigned when the root item has been set as assetable in the catalog and has been configured.",
"type":"string"
},
"customerAccountId":{
"description":"The customer account ID associated to the current item.",
"type":"string"
},
"actionCode":{
"description":"The action code that has been set on the item by the configurator system.",
"type":"string"
},
"activationDate":{
"description":"The activation date in ISO format.",
"type":"string"
},
"serviceId":{
"description":"The service ID associated to the current item.",
"type":"string"
},
"asset":{
"description":"The flag that determines if the current item is an asset or not.",
"type":"boolean"
}
},
"required":[
"quantity",
"productId",
"catRefId"
]
}
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":{
"values":{
"description":"The array of values associated with an externalData item.",
"type":"object",
"properties":{
"dynamic_property_key":{
"description":"This property's name and value will be retrieved from a configurator system, so will be dynamically set.",
"type":"string"
}
},
"required":[
"dynamic_property_key"
]
},
"name":{
"description":"The name to be associated with the externalData item.",
"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"
]
}