WebSphere Commerce Service - Marketing and Promotions
These services provide APIs related to marketing and promotional activities in either a B2B or B2C store. Use these classes to:
- Get, add, update, or delete assigned coupons
- Get, add, update, or delete assigned promotion codes
- Get spot details
- Get e-Marketing Spot data
- Get customer segment data
- Get activity details, associated promotions
- Trigger marketing based on certain types of events Schemes: https
Summary
Tag: Spot
This class provides RESTful services to retrieve spot details.
Operation Description GET /store/{storeId}/spot/{spotId} Get e-Marketing Spots by unique identifier
GET /store/{storeId}/spot Get e-Marketing Spots
Tag: Assigned Coupon
This class provides RESTful services to get, add, update, and delete assigned coupons for the current shopping cart.
Operation Description POST /store/{storeId}/cart/@self/assigned_coupon Get coupons
GET /store/{storeId}/cart/@self/assigned_coupon Apply coupons
DELETE /store/{storeId}/cart/@self/assigned_coupon/{couponId} Delete coupons
Tag: activity
Operation Description GET /store/{storeId}/activity/urls Resolve email activity urls
Tag: E-spot
This class provides RESTful services to get e-Marketing Spot data. It uses the MarketingSpotData noun.
Operation Description GET /store/{storeId}/espot/{name}/product/{productId} Get e-Marketing Sport for product
GET /store/{storeId}/espot/{name} Get e-Marketing Spot by name
GET /store/{storeId}/espot Get search terms with search rules
GET /store/{storeId}/espot/{name}/category/{categoryId} Get e-Marketing Spot for category
GET /store/{storeId}/espot/{name}/type/{type} Get e-Marketing Sport data
Tag: Assigned Promotion Code
This class provides RESTful services to get, add, update, and delete assigned promotion codes for the current shopping cart.
Tag: Coupon
This class provides RESTful services to get and process coupon information. For example, deleting a coupon from the list.
Operation Description POST /store/{storeId}/coupon/@self Get coupons
GET /store/{storeId}/coupon/@self Get coupons for shopper
DELETE /store/{storeId}/coupon/{couponId} Delete coupons by ID
Tag: Segment
This class provides RESTful services to retrieve the customer segment data.
Operation Description GET /store/{storeId}/segment/{segmentId} Get segment by the segment ID
GET /store/{storeId}/segment/{segmentId}/isMember Check segment membership
GET /store/{storeId}/segment Get segment by user or store ID
Tag: Event
This class provides RESTful services to trigger marketing based on certain types of events. For example, CategoryDisplay, ProductDisplay, or Search.
Operation Description GET /store/{storeId}/event/behavior_rules Get user behavior rules
POST /store/{storeId}/event Trigger marketing by event
POST /store/{storeId}/event/click_info Handle click information
POST /store/{storeId}/event/evaluate_triggers Evaluate triggers
Tag: Promotion
This class provides RESTful services to get promotion data using the Promotion noun.
Operation Description GET /store/{storeId}/promotion Get promotion list by query
GET /store/{storeId}/promotion/{promotionId} Get promotion list by ID
Tag: Activity
This class provides RESTful services to retrieve activity details.
Operation Description GET /store/{storeId}/activity Get activity list
Tag: Associated Promotion
This class provides RESTful services to retrieve associated promotions.
Operation Description GET /store/{storeId}/associated_promotion Get promotion list
Paths
Get activity listGET /store/{storeId}/activity
Tags: ActivityGets the activity list by query type and parameters.
storeId The store identifier.
path string q The query name.
query string , x ∈ { getEmailActivityDetailsByEmailPromotionId }
Resolve email activity urls application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/activity/urls
Tags: activity
storeId The store identifier.
path string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 } emailPromotionId query string urlHeader query string userId query string optOutForwardUrl query string clickedEventUrl query string
Get promotion list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/associated_promotion
Tags: Associated PromotionGets promotions list by product ID.
responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } storeId The store identifier.
path string currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP } profileName Profile name. Profiles determine the subset of data returned by a query.
query string qProductId The product ID.
query string qCalculationUsageId The calculation usage ID.
query string qCode The calculation code name.
query string qEnableStorePath Whether the data bean searches for calculation code based on store path. Default is true.
query string qIncludeCategoryPromotions Whether to exclude category promotions. Default is false.
query string qIncludeChildItems Whether to include the child items. Default is false.
query string qIncludeNonManagementCenterPromotions Whether all the promotions in the store have been created in Management Center. Default is false.
query string qIncludeParentCategories Whether to retrieve the calculation codes attached to the parent category of the specified catalog group. Default is false.
query string qIncludeParentProduct Whether to retrieve the calculation codes attached to the parent product of the specified catalog entry. Default is false.
query string qIncludePromotionCode Whether to exclude the calculation codes that require a promotion code. Default is true.
query string qIncludeUnentitledPromotionsByMemberGroup Whether to include promotions that are targeted to a member group if the user does not belong to the member group. Default is false.
query string qShipModeId The ship mode ID.
query string qUserId The user ID.
query string q The query name.
query string , x ∈ { byProduct } qCategoryId query integer (int64) qDisplayLevel query integer (int32) qStoreId query integer (int32)
application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"resultList": [
{
"attachedCatalogEntries": [
],
"calculationCodeId": "10011",
"calculationUsageId": "-1",
"code": "Furniture Category Discount",
"descriptionString": "Save 20% on Furniture!",
"endDate": "2999-12-31 23:59:59.0",
"isPromotionRelated": true,
"longDescriptionString": "Save 20% on all Furniture items! No restrictions!",
"startDate": "2004-01-01 00:00:00.0"
}
]
}com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
Apply coupons
GET /store/{storeId}/cart/@self/assigned_coupon
Tags: Assigned CouponApplies applicable coupons to the shopping cart.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get coupons application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"couponCode": [
{
"couponId": "100000000001",
"description": [
{
"language": "-1",
"longDescription": "15% off your order",
"shortDescription": "15% off your order",
"userData": null
}
],
"effectiveDateTime": "2014-11-24T20:22:36.124Z",
"expirationDateTime": "2014-12-01T20:22:36.124Z",
"promotion": {
"calculationCodeIdentifier": null,
"externalIdentifier": {
"name": "15% off order-10000203",
"revision": "0",
"storeIdentifier": null,
"version": "1"
},
"uniqueID": "10000203"
},
"status": "2",
"xcpcd_promotionAdministrativeDescription": "15% off order",
"xcpcd_promotionStatus": "1"
}
],
"orderId": "25207",
"resourceId": "https://localhost:443/wcs/resources/store/10001/cart/@self/assigned_coupon",
"resourceName": "cart"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/cart/@self/assigned_coupon
Tags: Assigned CouponGets all assigned coupons for the shopping cart.
application/json application/xml
The request body for applying a coupon to the shopping cart. com.ibm.commerce.rest.order.handler.AssignedCouponHandler$ApplyCouponBody
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Delete coupons application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified. Example for application/json
{
"couponId": "100000000001",
"orderId": "25207"
}com.ibm.commerce.rest.order.handler.AssignedCouponHandler$ApplyCouponResponse
201 Created The requested resource has been created.
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
DELETE /store/{storeId}/cart/@self/assigned_coupon/{couponId}
Tags: Assigned CouponDeletes all coupons from the shopping cart.
storeId The store identifier.
path string couponId Coupon identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Apply promotion codes application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"orderId": "25207"
}com.ibm.commerce.rest.order.handler.AssignedCouponHandler$RemoveCouponResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/cart/@self/assigned_promotion_code
Tags: Assigned Promotion CodeApplies relevant promotion codes to the shopping cart.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get promotion codes application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"orderId": "25207",
"promotionCode": [
{
"associatedPromotion": [
{
"description": "",
"promotionId": "10000202"
}
],
"code": "10%OFF"
}
],
"resourceId": "https://localhost:443/wcs/resources/store/10001/cart/@self/assigned_promotion_code",
"resourceName": "cart"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/cart/@self/assigned_promotion_code
Tags: Assigned Promotion CodeGets relevant promotion codes for the current shopping cart.
application/json application/xml
The request body for applying promotion codes to the shopping cart. com.ibm.commerce.rest.order.handler.AssignedPromotionCodeHandler$ApplyPromotionCodeBody
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Delete promotion codes application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified. Example for application/json
{
"orderId": "25207",
"promoCode": "10%OFF"
}com.ibm.commerce.rest.order.handler.AssignedPromotionCodeHandler$ApplyPromotionCodeResponse
201 Created The requested resource has been created.
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
DELETE /store/{storeId}/cart/@self/assigned_promotion_code/{promoCode}
Tags: Assigned Promotion CodeDeletes relevant promotion codes from the current shopping cart.
storeId The store identifier.
path string promoCode The promotion code.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get coupons for shopper application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"orderId": "24208"
}com.ibm.commerce.rest.order.handler.AssignedPromotionCodeHandler$RemovePromotionCodeResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/coupon/@self
Tags: CouponGets available coupons for the current shopper.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Get coupons application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"Coupon": [
{
"couponDescription": [
{
"language": "-1",
"longDescription": "15% off your order",
"shortDescription": "15% off your order",
"userData": null
}
],
"couponId": "100000000001",
"effectiveDateTime": "2014-11-24T20:22:36.124Z",
"expirationDateTime": "2014-12-01T20:22:36.124Z",
"promotion": {
"calculationCodeIdentifier": null,
"externalIdentifier": {
"name": "15% off order-10000203",
"revision": 0,
"storeIdentifier": null,
"version": 1
},
"uniqueID": "10000203"
},
"resourceId": "https://localhost:443/wcs/resources/store/10001/coupon/100000000001",
"status": "0",
"userData": {
"userDataField": [
{
"key": "promotionAdministrativeDescription",
"value": "15% off order"
},
{
"key": "promotionStatus",
"value": "1"
}
]
}
}
],
"recordSetComplete": true,
"recordSetCount": 1,
"recordSetStartNumber": 0,
"recordSetTotal": 1,
"resourceId": "https://localhost:443/wcs/resources/store/10001/coupon/@self/?responseFormat=json",
"resourceName": "coupon"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/coupon/@self
Tags: CouponAllows the shopper to get their own coupons.
Issue coupon.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Delete coupons by ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.marketing.commands.IssueCouponControllerCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
DELETE /store/{storeId}/coupon/{couponId}
Tags: CouponDeletes coupons from coupon wallet by coupon ID.
storeId The store identifier.
path string couponId Coupon identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get search terms with search rules application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/espot
Tags: E-spotGets all search terms that have search rules.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string q The query name.
query string , x ∈ { allSearchTerms }
Get e-Marketing Spot by name application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$SearchTermsContainer
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/espot/{name}
Tags: E-spotGets an e-Marketing Spot by name.
name E-Spot name.
path string storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } catalogId The catalog identifier. If none is specified, the store default catalog is used.
query string currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP } name E-Spot name.
query string
Get e-Marketing Spot for category application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"MarketingSpotData": [
{
"baseMarketingSpotActivityData": [
{
"MarketingContentDescription": [
{
}
],
"activityIdentifierID": "0",
"activityPriority": "1",
"baseMarketingSpotActivityID": "10065",
"baseMarketingSpotActivityName": "HomeKidsApparelAdContent",
"baseMarketingSpotDataType": "MarketingContent",
"contentClickAction": "None",
"contentFormatId": "2",
"contentFormatName": "Text",
"contentId": "10065",
"contentName": "HomeKidsApparelAdContent",
"contentStoreId": "10001",
"marketingContentDescription": [
{
"language": "-1",
"marketingText": "<link rel=\"stylesheet\" href=\"/wcsstore/Aurora/rwdWebAssets/homePageEspot_Right/styles.css\" /> <div class=\"col4\" id=\"homePageEspot_Right\" role=\"region\" aria-label=\"home page Espot kids\"> <div class=\"homeESpotContainer\" id=\"homePageEspot_Right_Slot\"> <div class=\"textContainer\"> <div class=\"title\"> Kids' Stuff </div> <div class=\"bodyText\"> Summer style is all about fun prints, bright colors, comfort, and durability. Stock up on our easy-to-wear and affordable fashions for kids. Spend $100* or more, and earn a $25 gift certificate. <div class=\"finePrint\"> *Before taxes. Gift certificates are redeemable on your next visit. </div> </div> <div class=\"button\"><a alt=\"\" role=\"link\" aria-label=\"Shop now girls category\" href=\"http://localhost/webapp/wcs/stores/servlet/en/aurora/apparel/girls\">shop now</a></div> </div> <div class=\"imageContainer\"> <img alt=\"\" id=\"kids1\" src=\"/wcsstore/Aurora/rwdWebAssets/homePageEspot_Right/kids1.jpg\"> <img alt=\"\" id=\"kids2\" src=\"/wcsstore/Aurora/rwdWebAssets/homePageEspot_Right/kids2.png\"> </div> </div> </div>"
}
],
"properties": [
{
"baseMarketingKey": "mktActivityDescription"
},
{
"baseMarketingKey": "displaySequence",
"baseMarketingValue": "1.0"
}
]
}
],
"behavior": "0",
"defaultContentDisplaySequence": [
{
"displaySequence": "1.0",
"resultFormat": "MarketingContent",
"resultId": "10065"
}
],
"eSpotName": "HomeBottomRight_Content",
"marketingSpotIdentifier": "10562",
"nextTimeLimit": "-1"
}
],
"resourceId": "http://localhost:80/wcs/resources/store/10001/espot/HomeBottomRight_Content?DM_marketingSpotBehavior=&deleteIfEmpty=*&orderId=14029&toOrderId=.&page=&DM_ReqCmd=TopCategoriesDisplay&calculationUsageId=-1&DM_SubstitutionValue1=Aurora&catalogId=10052&createIfEmpty=1&DM_SubstitutionValue2=http%3A%2F%2Flocalhost%2Fwebapp%2Fwcs%2Fstores%2Fservlet%2Fen%2Faurora&DM_SubstitutionValue3=en_US&DM_SubstitutionValue4=&DM_SubstitutionValue5=&DM_SubstitutionValue6=_8_-2000_1469&storeId=10001&DM_EmsName=HomeBottomRight_Content&continue=1&langId=-1&DM_imagePath=%2Fwcsstore%2FAurora%2F&deleteCartCookie=true&pageGroup=Content&updatePrices=0&DM_SubstitutionName1=%5BstoreName%5D&DM_SubstitutionName2=%5BfullPathHomeURL%5D&DM_SubstitutionName3=%5Blanglocale%5D&DM_SubstitutionName4=%5BproductTotalCount%5D&DM_SubstitutionName5=%5BcontentTotalCount%5D&DM_SubstitutionName6=%5BwidgetSuffix%5D&pageName=HomePage&DM_contextPath=%2Fwebapp%2Fwcs%2Fstores%2Fservlet&fromOrderId=*&responseFormat=json",
"resourceName": "espot"
}com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/espot/{name}/category/{categoryId}
Tags: E-spot"Deprecated: Gets an e-Marketing Spot at a specific category level. For example, Furniture. Alternatively, this can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?categoryId=&DM_ReqCmd=CategoryDisplay."
name E-Spot name.
path string storeId The store identifier.
path string categoryId The category identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } catalogId The catalog identifier. If none is specified, the store default catalog is used.
query string currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Get e-Marketing Sport for product application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"MarketingSpotData": [
{
"behavior": "0",
"eSpotName": "ESpotDataHandlerESpotName",
"marketingSpotIdentifier": "15560",
"nextTimeLimit": "-1"
}
],
"resourceId": "http://localhost:80/wcs/resources/store/10001/espot/ESpotDataHandlerESpotName/category/10044?numberProductsToDisplay=2&DM_ReqCmd=CategoryDisplay2",
"resourceName": "espot"
}com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/espot/{name}/product/{productId}
Tags: E-spot"Deprecated: Gets an e-Marketing Spot for a specific product. Alternatively, this can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?productId=&DM_ReqCmd=ProductDisplay."
name E-Spot name.
path string storeId The store identifier.
path string productId The product identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } catalogId The catalog identifier. If none is specified, the store default catalog is used.
query string currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { ARS , ATS , AUD , BEF , BRL , CAD , CHF , CNY , DEM , DKK , EGP , ESP , EUR , FIM , FRF , GBP , HKD , IEP , ITL , JPY , KRW , LUF , NLG , NOK , PLN , PTE , ROL , RON , RUB , SEK , SGD , TWD , USD , ZAR }
Get e-Marketing Sport data application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"MarketingSpotData": [
{
"behavior": "0",
"eSpotName": "ESpotDataHandlerESpotName",
"marketingSpotIdentifier": "15562",
"nextTimeLimit": "-1"
}
],
"resourceId": "http://localhost:80/wcs/resources/store/10001/espot/ESpotDataHandlerESpotName/product/12973?numberContentToDisplay=1&DM_ReqCmd=ProductDisplay2",
"resourceName": "espot"
}com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/espot/{name}/type/{type}
Tags: E-spotGets e-Marketing Spot data.
storeId The store identifier.
path string name E-Spot name.
path string type E-Marketing Spot type for example, SEARCH.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } catalogId The catalog identifier. If none is specified, the store default catalog is used.
query string currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP } name E-Spot name.
query string
Trigger marketing by event application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. espot-espot
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/event
Tags: EventTriggers marketing based on certain events.
Marketing event trigger body. com.ibm.commerce.rest.marketing.handler.EventHandler$EventTrigger
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get user behavior rules application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/event/behavior_rules
Tags: EventGets user behavior rules.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string
Handle click information application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/event/click_info
Tags: EventHandles click information.
Marketing evaluate trigger body. com.ibm.commerce.rest.marketing.handler.EventHandler$EventTrigger
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Evaluate triggers application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.marketingcenter.events.runtime.ClickMonitorCommand
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/event/evaluate_triggers
Tags: EventEvaluates potential triggers passed from the store.
Marketing evaluate trigger body. com.ibm.commerce.rest.marketing.handler.EventHandler$EventTrigger
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get promotion list by query application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/promotion
Tags: PromotionGets the promotion list by query type and parameters.
storeId The store identifier.
path string langId Language identifier. If not specified, the "locale" parameter is used. If "locale" is not specified, then the store default language is used.
query string , x ∈ { -1 , -2 , -3 , -4 , -5 , -6 , -7 , -8 , -9 , -10 , -20 , -21 , -22 , -23 } q The query name.
query string , x ∈ { all , byName } qName The name of the promotion to find when finding promotions by name.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Get promotion list by ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. promotion-promotion
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/promotion/{promotionId}
Tags: PromotionGets promotions by ID.
storeId The store identifier.
path string promotionId The promotion identifier.
path integer (int32) langId Language identifier. If not specified, the "locale" parameter is used. If "locale" is not specified, then the store default language is used.
query string , x ∈ { -1 , -2 , -3 , -4 , -5 , -6 , -7 , -8 , -9 , -10 , -20 , -21 , -22 , -23 } responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Get segment by user or store ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. promotion-promotion
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/segment
Tags: SegmentGets all customer segments by a specified storeId or get segment by userId or personalizationId or byName.
storeId The store identifier.
path string q The query name.
query string , x ∈ { byUserId , byPersonalizationId , byName , all } qUserId The user identifier. Required if the query is set to byUserId.
query integer (int64) qPersonalizationId The user's personalization identifier. Required if the query is set to byPersonalizationId.
query string qName The user's name. Required if the query is set to byName.
query string pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get segment by the segment ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. segment-segments
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/segment/{segmentId}
Tags: SegmentGets customer segment by segmentId.
storeId The store identifier.
path string segmentId The segment identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Check segment membership application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"MemberGroup": [
{
"description": {
"language": "-1",
"value": "Shoppers who have not registered with the store"
},
"displayName": {
"language": "-1",
"value": "Guest Shoppers"
},
"id": "8000000000000000003",
"usage": [
"GeneralPurpose"
]
}
],
"recordSetComplete": true,
"recordSetCount": 1,
"recordSetStartNumber": 0,
"recordSetTotal": 1,
"resourceId": "https://localhost:443/wcs/resources/store/10001/segment/8000000000000000003",
"resourceName": "segment"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/segment/{segmentId}/isMember
Tags: SegmentChecks if the customer identified by userId or personalizationId is part of given customer segment.
storeId The store identifier.
path string segmentId Segment identifier.
path string userId User unique identifier.
query integer (int64) personalizationId The user's personalization id. Note : this parameter is ignored if the userId parameter is specified.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get e-Marketing Spots application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"isInCustomeSegment": true
}com.ibm.commerce.rest.marketing.handler.SegmentHandler$SegmentMemberCheck
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/spot
Tags: SpotGets e-Marketing Spots in a store.
storeId The store identifier.
path string q The query name.
query string , x ∈ { byType , byTypeAndName } responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } qType Type of the e-spot. For instance : qType=MARKETING. Required for search by type.
query string qName Name of the e-spot used to find all spots with at least a partial match in the name or description. Required for search by name.
query string catalogId The catalog identifier. If none is specified, the store default catalog is used.
query string pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query string pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query string
Get e-Marketing Spots by unique identifier application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. spot-spot
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/spot/{spotId}
Tags: SpotGets an e-Marketing Spot in a store using its unique identifier.
storeId The store identifier.
path string spotId E-Spot identifier.
path integer (int32) responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32)
application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"MarketingSpot": [
{
"description": "Display the main ad on About Dress Designer page",
"spotId": "10589",
"spotName": "AboutDressDesignerPageMainAd",
"type": "MARKETING",
"uiDisplayable": 1
}
],
"recordSetComplete": true,
"recordSetCount": 1,
"recordSetStartNumber": 0,
"recordSetTotal": 1,
"resourceId": "https://localhost:443/wcs/resources/store/10001/spot/10589",
"resourceName": "spot"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
Schema definitions
cart-assigned_coupon: object
- orderId: string
- quoteID: string
- couponCode: object[]
cart-assigned_coupon.couponCode - externalOrderID: string
- quoteIdentifier: com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType
- buyerPONumber: string
- customerOrderNumber: string
- channel: com.ibm.commerce.order.facade.datatypes.ChannelType
cart-assigned_coupon.couponCode: object
- status: string
- code: string
- couponId: string
- expirationDateTime: string
- effectiveDateTime: string
- promotion: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType
- userDataField: object[]
cart-assigned_coupon.couponCode.userDataField - description: object[]
com.ibm.commerce.order.facade.datatypes.CouponDescriptionType
cart-assigned_coupon.couponCode.userDataField: object
- value: string
- key: string
cart-assigned_promotion_code: object
- orderId: string
- quoteID: string
- externalOrderID: string
- quoteIdentifier: com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType
- buyerPONumber: string
- customerOrderNumber: string
- promotionCode: object[]
cart-assigned_promotion_code.promotionCode - channel: com.ibm.commerce.order.facade.datatypes.ChannelType
cart-assigned_promotion_code.promotionCode: object
- associatedPromotion: object[]
cart-assigned_promotion_code.promotionCode.associatedPromotion - code: string
cart-assigned_promotion_code.promotionCode.associatedPromotion: object
- description: string
- promotionId: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType: object
- catalogGroupReference: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference
- name: string
- catalogEntryReference: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference
- associationCodeType: string
- displaySequence: number (double)
- associatedObject: com.ibm.commerce.catalog.facade.datatypes.AssociationType.associatedObject
- uniqueID: string
- externalSource: boolean
- attributes: object[]
com.ibm.commerce.catalog.facade.datatypes.AssociationType.attributes - associatedObjectGroup: object[]
Empty - semantic: string
- quantity: number (double)
com.ibm.commerce.catalog.facade.datatypes.AssociationType.associatedObject: object
com.ibm.commerce.catalog.facade.datatypes.AssociationType.attributes: object
- value: string
- key: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference: object
- catalogEntryIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier
- displayName: string
- catalogEntryTypeCode: string
- navigationPath: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference: object
- catalogGroupIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier
- displayName: string
- catalogIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier
- navigationPath: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier: object
- ownerID: string
- storeIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier
- groupIdentifier: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier: object
- ownerID: string
- identifier: string
- storeIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType: object
- userData: com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData
- floatValue: com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.floatValue
- attributeValue: com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.attributeValue
- language: string
- default: boolean
- displaySequence: number (double)
- attributeValueGroup: object[]
Empty - value: string
- extendedValue: object[]
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.extendedValue - stringValue: com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.stringValue
- storeID: string
- identifier: string
- integerValue: com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.integerValue
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.attributeValue: object
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.extendedValue: object
- value: string
- key: string
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.floatValue: object
- value: number (float)
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.integerValue: object
- value: integer (int32)
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.stringValue: object
- value: string
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData: object
- userDataField: object[]
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData.userDataField
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.catalog.facade.datatypes.AttributeValueType: object
com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType: object
- userData: com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData
com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData: object
- userDataField: object[]
com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData.userDataField
com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.catalog.facade.datatypes.CatalogEntryNavigationRelationshipType: object
com.ibm.commerce.catalog.facade.datatypes.FloatValueType: object
- value: number (float)
com.ibm.commerce.catalog.facade.datatypes.IntegerValueType: object
- value: integer (int32)
com.ibm.commerce.catalog.facade.datatypes.KitComponentType: object
- attributes: object[]
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.attributes - displaySequence: number (double)
- quantity: number (double)
- kitComponentCodeType: string
- catalogEntryReference: com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.attributes: object
- value: string
- key: string
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference: object
- catalogEntryIdentifier: com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier
- displayName: string
- catalogEntryTypeCode: string
- navigationPath: string
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.catalog.facade.datatypes.ValueType: object
- identifier: string
- value: string
- storeID: string
com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType: object
- userData: com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType: object
- userData: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData
- attachmentIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier
- attachmentReferenceIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceIdentifier
- displaySequence: string
- attachmentReferenceDescription: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription - attachmentAsset: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset - attachmentDescription: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription - attachmentUsage: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset: object
- mimeType: string
- attachmentAssetIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.attachmentAssetIdentifier
- rootDirectory: string
- language: string[]
string - directoryPath: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier
- localAsset: boolean
- userData: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData
- attachmentAssetPath: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.attachmentAssetIdentifier: object
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription: object
- userData: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier: object
- ownerID: string
- identifier: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription: object
- userData: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceIdentifier: object
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage: object
- displaySequence: string
- attachmentUsageDescription: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription
- image: string
- usageName: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription: object
- userData: com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier: object
- attributeDictionaryIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier
- identifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier: object
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier
- identifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier: object
- attributeDictionaryIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier
- identifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier: object
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier
- identifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier: object
- ownerID: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier
- groupIdentifier: string
com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType.externalIdentifier: object
- majorVersionNumber: integer (int32)
- origin: string
- minorVersionNumber: integer (int32)
- name: string
- ownerID: string
com.ibm.commerce.foundation.common.datatypes.DescriptionType: object
- value: string
- language: string
com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType: object
- currency: string
- value: number (double)
com.ibm.commerce.foundation.common.datatypes.OfferPriceType: object
- lastUpdate: string
- endDate: string
- description: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.description
- precedence: number (double)
- quantityUnit: string
- contractIdentifier: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier
- price: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price
- maximumQuantity: number (double)
- minimumQuantity: number (double)
- userData: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData
- startDate: string
- qualifier: string
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier.externalIdentifier: object
- majorVersionNumber: integer (int32)
- origin: string
- minorVersionNumber: integer (int32)
- name: string
- ownerID: string
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.description: object
- value: string
- language: string
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price: object
- price: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.price
- quantity: com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.quantity
- alternativeCurrencyPrice: object[]
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.alternativeCurrencyPrice
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.alternativeCurrencyPrice: object
- currency: string
- value: number (double)
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.price: object
- currency: string
- value: number (double)
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.quantity: object
- value: number (double)
- uom: string
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.OrderIdentifierType: object
- customerOrderNumber: string
- externalOrderID: string
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType: object
- calculationCodeIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier: object
- calculationCodeExternalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier: object
- calculationUsageID: string
- code: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier: object
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier
- version: integer (int64)
- name: string
- revision: integer (int64)
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.QuantityType: object
- value: number (double)
- uom: string
com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType: object
- externalQuoteID: string
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType: object
- resolved: boolean
- userData: com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData
- language: string
- metaKeyword: string
- fullImageAltDescription: string
- parentStoreIdentifier: com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier
- pageGroup: string
- objectIdentifier: string
- sEOPageDefID: string
- title: string
- metaDescription: string
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.SEOURLType: object
- userData: com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData
- parentStoreIdentifier: com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier
- tokenValue: string
- uRLKeywordID: string
- uRLKeyword: object[]
com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword - usage: string
- siteMapInfo: com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo
com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo: object
- priority: number (double)
- userData: com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData
- mobilePriority: number (double)
- changeFrequency: string
- mobileChangeFrequency: string
com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword: object
- userData: com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData
- keyword: string
- language: string
- generatedMobileKeyword: string
- uRLPrefix: string
- mobileURLPrefix: string
- previewURL: string
- mobileKeyword: string
- generatedKeyword: string
- previewMobileURL: string
com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.UserDataType: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.UserDataType.userDataField
com.ibm.commerce.foundation.common.datatypes.UserDataType.userDataField: object
- value: string
- key: string
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary: object
- associatedPromotions: object[]
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary.associatedPromotions
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary.associatedPromotions: object
- startDate: string
- code: string
- endDate: string
- description: com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary.associatedPromotions.description
- associatePromotionId: string
com.ibm.commerce.fulfillment.beans.CalculationCodeListDataBean_IBM_associatedPromotionsList_Summary.associatedPromotions.description: object
- shortDescription: string
- langId: string
- longDescription: string
com.ibm.commerce.marketing.commands.IssueCouponControllerCmd: object
com.ibm.commerce.marketing.facade.datatypes.AreaType: object
- userData: com.ibm.commerce.marketing.facade.datatypes.AreaType.userData
- target: string
- title: string
- url: string
- displaySequence: number (double)
- coordinates: string
- shape: string , x ∈ { rect , circle , poly }
- uniqueID: string
- alternateText: string
com.ibm.commerce.marketing.facade.datatypes.AreaType.userData: object
- userDataField: object[]
com.ibm.commerce.marketing.facade.datatypes.AreaType.userData.userDataField
com.ibm.commerce.marketing.facade.datatypes.AreaType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.marketingcenter.events.runtime.ClickMonitorCommand: object
com.ibm.commerce.order.facade.datatypes.ChannelType: object
- userData: com.ibm.commerce.order.facade.datatypes.ChannelType.userData
- channelIdentifer: com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer
- description: com.ibm.commerce.order.facade.datatypes.ChannelType.description
com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer: object
- channelName: string
- uniqueID: string
com.ibm.commerce.order.facade.datatypes.ChannelType.description: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.ChannelType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.CouponDescriptionType: object
- userData: com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData
- shortDescription: string
- language: string
- longDescription: string
com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.promotion.facade.datatypes.PromotionScheduleType: object
- dailyStartTime: string
- dailyEndTime: string
- endDate: string
- weekDays: string , x ∈ { Sunday , Monday , Tuesday , Wednesday , Thursday , Friday , Saturday }
- startDate: string
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer: object
Structure containing attachment description.
- attachmentName: string
Language-dependent name of the attachment.
- attachmentLanguage: string
Supported languages of an attachment asset.
- attachmentLongDescription: string
Long description of the attachment.
- attachmentShortDescription: string
Short description of the attachment.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer2: object
Not used.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer: object
Structure containing an e-marketing spot.
- MarketingSpotData: object[]
Data to display in the e-marketing spot.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer: object
Data to display in the e-marketing spot.
- eSpotStoreId: string
The store identifier.
- nextTimeLimit: string
The number of seconds from now to the earliest start date or end date of activities scheduled to the e-Marketing Spot.
- marketingSpotIdentifier: string
The unique identifier of the e-marketing spot.
- baseMarketingSpotActivityData: object[]
Base e-marketing spot activity data.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer - filteredResult: object[]
Result that was filtered from display in the e-Marketing Spot.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$FilteredResultContainer - defaultContentDisplaySequence: object[]
Sequence values of the default content to display in the e-marketing spot.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$DefaultContentDisplaySequenceContainer - marketingSpotDataTitle: object[]
Marketing title to display in the e-marketing spot.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$MarketingSpotDataTitleContainer - eSpotName: string
The e-marketing Spot name.
- behavior: string
The current caching behavior of the e-marketing spot.
- previewReport: string[]
Information about the activity evaluation.
string
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer: object
The data to display in the e-marketing spot. This contains the data and the information about the activity that returned this data.
- attachmentReferenceId: string
Unique identifier for the attachment reference.
- attachmentUsageName: string
Name of the attachment usage.
- standardPriceQuantity: string
Quantity of a unit.
- standardPriceCurrency: string
Currency of the standard price.
- contentName: string
Name of the marketing content.
- standardPriceAltCurrencyPrice: string
Unit price in other currencies.
- standardPricePrecedence: string
Precedence of contract.
- standardPriceQualifier: string
A uniquely identifying number that identifies the standard price.
- standardPriceMinQuantity: string
Minimum quantity.
- attachementOwnerId: string
Owner of the attachment target.
- standardPriceStartDate: string
Start date.
- standardPriceQuantityUnit: string
Unit of measure for minimumQuantity and maximumQuantity.
- xcatg_displayTemplate: string
The display template for the catalog group.
- topCatalogGroup: string
Attribute indicating whether catalog group is a top-level catalog group.
- standardPriceLastUpdate: string
Date of last update.
- navigationRelationship: string
Type definition for a navigational relationship.
- attachementExternalId: string
External identifying name for the attachment target.
- storeIdentifier: string
External store identifier for the catalog entry/catalog group.
- MarketingContentDescription: object[]
Not used.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$MarketingContentDescriptionContainer2 - listPrice: com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$ListPriceContainer
- contentInputOption: string
The input options for the marketing content image map. Two options are support: "Area" means the image map is defined by individual area. "Source" means the image map is defined by HTML source code.
- marketingContentDescription: object[]
Description of the marketing content.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$MarketingContentDescriptionContainer - AttachmentReferenceDescription: object[]
Not used.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer2 - attachmentDescription: object[]
Description of an attachment.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer - attachmentImage: string
Image path of the attachment relation usage.
- standardPriceDescription: string
Description of the standard price.
- categoryId: string
Unique identifier for the category.
- attachmentAsset: object[]
Definition of an attachment asset.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttachmentAssetContainer - contentClickAction: string
Number of click actions of the marketing content: "None", "Single"(URL) or "Multiple"(Image Map).
- contentUrl: string
Click action to invoke when marketing content on the page is clicked.
- standardPriceContractID: string
Contract identifier the standard price is associated with.
- baseMarketingSpotActivityID: string
Unique identifier for the data displayed in the e-Marketing Spot.
- standardPrice: string
The standard price.
- attachmentUsageDescription: object[]
Language or locale specific description of an attachment.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer - description: object[]
Description of the catalog entry/category.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$DescriptionContainer - attachementStoreExternalId: string
External identifier of the store that owns the attachment.
- contentMimeType: string
MIME type of the marketing content.
- categoryIdentifier: string
Catalog group identifier.
- activityIdentifierID: string
Unique identifier for the activity.
- attachementId: string
Identifier for the attachment.
- parentCatalogGroupId: string
Parent catalog group identifier. Null for top-level catalog groups.
- sEOURL: string
SEO URL associated with the catalog entry / catalog group.
- attachmentReferenceDescription: object[]
Description of the relationship between the business object and the attachment.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer - activityPriority: string
Priority of the activity that returned the data to display in the e-Marketing Spot.
- xcatg_rootDirectory: string
The root directory for the catalog group.
- ownerId: string
Owner organization of the catalog entry/catalog group.
- taxonomyAttribute: string
Taxonomy attributes for the catalog group.
- attachmentDisplaySequence: string
Sequence of the attachment relation usage.
- contentFormatId: string
Unique ID of the type of the marketing content.
- baseMarketingSpotCampaignName: string
Name of the campaign that returned the data to display in the e-Marketing Spot.
- properties: object[]
Properties related to marketing content.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$PropertiesContainer - association: string
Association to other objects.
- contentStoreId: string
Identifier of the store associated with the marketing content.
- activityFormat: string
Type of the activity that returned the data to display in the e-marketing spot.
- baseMarketingSpotDataType: string
Type of the data displayed in the e-marketing spot.
- sEOProperties: string
SEO properties associated with the catalog entry / catalog group.
- standardPriceEndDate: string
End date.
- catalogEntryTypeCode: string
Catalog entry type code.
- displaySequence: string
Sequence of display of catalog entry.
- contentFormatName: string
Name of the type of the marketing content.
- activityIdentifierName: string
Name of the activity.
- attachementStoreId: string
Identifier of the store that owns the attachment.
- standardPriceMaxQuantity: string
Maximum quantity.
- productPartNumber: string
Part number or SKU for the product.
- AttachmentDescription: object[]
Not used.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$AttachmentDescriptionContainer2 - contentId: string
Unique ID of the marketing content.
- attributes: object[]
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttributesContainer - baseMarketingSpotActivityName: string
Name of the data displayed in the e-marketing spot.
- productId: string
Unique ID of the product.
- categoryGroupId: string
Catalog group identifier.
- contentStoreExternalId: string
Unique external identifier of the store associated with the marketing content.
- contractPrice: object[]
The contract price object.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$ContractPriceContainer
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttachmentAssetContainer: object
Structure containing the attachment asset.
- attachmentAssetLanguage: string[]
Language ID for the language-specific fields in this input file.
string - attachmentLocalAsset: string
Attribute to indicate whether this attachment is a local attachment.
- attachmentAssetMimeType: string
MIME type of the attachment asset.
- attachmentAssetRootDirectory: string
Root directory for the attachment asset.
- attachmentAssetDirectoryPath: string
Directory path to the attachment asset.
- attachmentAssetId: string
Identifier of the attachment asset.
- attachmentAssetStoreExternalId: string
External identifier of the store that owns the attachment asset.
- attachmentAssetStoreId: string
Identifier of the store that owns the attachment asset.
- attachmentAssetPath: string
Relative path of the attachment asset.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttributesContainer: object
Structure containing attributes.
- description: string
Attribute description.
- comparable: string
If attribute can be used for comparison.
- allowedValue: object[]
Allowed values for the attribute.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttributesContainer$AttributeAllowedValueContainer - extendedValue: object[]
Name-value pairs for defining additional attribute values such as images and or attachments. Can also be used for customer extension.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$NVPAttributesContainer - name: string
Attribute name.
- language: string
Optional language for the attribute.
- displaySequence: string
Display sequence of a displayable attribute.
- floatValue: string
Type definition for a FloatValue attribute.
- attributeValue: string
Abstract attribute value for customer extension.
- attributeIdentifier: string
If the attribute is a reference to an attribute from the attribute dictionary.
- displayable: string
If attribute is displayable in storefront.
- attributeDataType: string
Attribute data type.
- values: object[]
All values for the attribute.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttributesContainer$AttributeAllowedValueContainer - groupPath: string
Group path of the attribute, listing all ancestor groups of this attribute.
- extendedData: object[]
Extended data.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$NVPAttributesContainer - usage: string
Use for the attribute.
- stringValue: string
Type definition for an StringValue attribute.
- searchable: string
If attribute can be used for search.
- parentAttributeGroup: string
Parent attribute group for this attribute.
- integerValue: string
Type definition for an IntegerValue attribute.
- attributeType: string
Attribute type.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$AttributesContainer$AttributeAllowedValueContainer: object
Structure containing the allowed values for the attribute.
- integerValue: string
Type definition for an IntegerValue attribute.
- stringValue: string
Type definition for an StringValue attribute.
- floatValue: string
Type definition for a FloatValue attribute.
- attributeValue: string
Abstract attribute value for customer extension.
- extendedValue: object[]
Name-value pairs for defining additional attribute values such as images and or attachments. Can also be used for customer extension.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$NVPAttributesContainer
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$ContractPriceContainer: object
Structure containing an contract price.
- majorVersionNumber: string
Major version.
- lastUpdate: string
Date of last update.
- endDate: string
End date.
- description: string
Description of the offer price.
- precedence: string
Precedence of contract.
- quantityUnit: string
Unit of measure for minimumQuantity and maximumQuantity.
- minorVersionNumber: string
Minor version.
- qualifier: string
A uniquely identifying number that identifies the contract price.
- startDate: string
Start date.
- currency: string
Currency of the offer price.
- maximumQuantity: string
Maximum quantity.
- minimumQuantity: string
Minimum quantity.
- contractID: string
Contract identifier the offer price is associated with.
- alternativeCurrencyPrice: string
Unit price in other currencies.
- ownerID: string
Owner of the contract.
- quantity: string
Quantity of a unit.
- contractPrice: string
The contract price.
- origin: string
Origin of the contract.
- name: string
Contact name.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$DescriptionContainer: object
Structure containing the catalog entry/category description.
- categoryName: string
Name of the category.
- language: string
Language type.
- fullImage: string
Full image of the catalog entity.
- longDescription: string
Long description of the catalog entity.
- keyword: string
Search keywords for the catalog entity.
- attributes: object[]
Set of name-value pair attributes.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$NVPAttributesContainer - productName: string
Name of the catalog entry.
- shortDescription: string
Short description of the catalog entity.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$ListPriceContainer: object
Structure containing a list price.
- listPriceAltCurrencyPrice: string
Unit price in other currencies.
- listPriceCurrency: string
Currency of the standard price.
- listPrice: string
The standard price.
- listPriceQuantity: string
Quantity of a unit.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$BaseMarketingSpotActivityDataContainer$PropertiesContainer: object
Structure containing optional properties related to marketing content to display.
- baseMarketingKey: string
Property key.
- baseMarketingValue: string
Property value.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$DefaultContentDisplaySequenceContainer: object
Structure containing the default content sequence values.
- displaySequence: string
Sequence value of the default content.
- resultId: string
Unique identifier of the result.
- resultFormat: string
Type of the result. Valid values include MarketingContent, CatalogGroup, CatalogEntry.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$FilteredResultContainer: object
Structure containing the filtered result.
- filteredResultId: string
The unique identifier of the filtered result.
- filteredResultFormat: string
The format of the filtered result.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$MarketingSpotDataTitleContainer: object
Structure containing the marketing title to display in the e-marketing spot.
- contentFormatName: string
Name of the type of the marketing content.
- marketingContentImageMap: object[]
Image map definition for the image with clickable areas.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$MarketingSpotDataTitleContainer$MarketingContentImageMapContainer - marketingSpotDataTitleId: string
Unique ID for the marketing content.
- MarketingContentDescription: object[]
Not used.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$MarketingContentDescriptionContainer2 - contentId: string
Unique ID of the marketing content.
- marketingSpotDataTitleDataType: string
Type of data displayed in the marketing content.
- marketingSpotDataTitleName: string
Name of the marketing content.
- marketingContentDescription: object[]
Description of the marketing content.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$MarketingContentDescriptionContainer - marketingSpotDataTitleActivityID: string
The unique identifier of the activity that returned the data to display in the e-marketing spot.
- contentClickAction: string
Number of click actions of the marketing content. : "None", "Single"(URL) or "Multiple"(Image Map).
- contentName: string
Name of the marketing content.
- contentFormatId: string
Unique ID of the type of the marketing content.
- contentStoreId: string
Identifier of the store associated with the marketing content.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$MarketingSpotDataTitleContainer$MarketingContentImageMapContainer: object
Structure containing image map definition for marketing content.
- source: string
HTML definition of the image map. This element is used when users want to define the whole image map directly using HTML.
- name: string
Name of the image map.
- area: object[]
Clickable area in the image map.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$MarketingSpotDataTitleContainer$MarketingContentImageMapContainer$AreaTypeContainer
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$ESpotContainer$MarketingSpotDataContainer$MarketingSpotDataTitleContainer$MarketingContentImageMapContainer$AreaTypeContainer: object
Structure containing the clickable area of an image map.
- title: string
Title of the area.
- url: string
Click action to invoke when the area is clicked.
- displaySequence: string
Sequence of the area.
- coordinates: string
Coordinates of the area.
- shape: string
Shape of the area: "rect" (Rectangle), "circle" (Circle), and "poly" (Polygon).
- uniqueID: string
Unique ID of the image map area.
- alternateText: string
Alternate text for the area.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$MarketingContentDescriptionContainer: object
Structure containing marketing content description.
- marketingText: string
Marketing text of a marketing content.
- contentLocation: string
Location of a marketing content.
- language: string
Supported languages of a marketing content.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$MarketingContentDescriptionContainer2: object
Not used.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$NVPAttributesContainer: object
Structure containing name-value pair attributes.
- value: string
Value.
- key: string
Key name.
com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$SearchTermsContainer: object
Structure containing multiple search terms.
- searchTerms: string
Encoded list of all the search terms.
com.ibm.commerce.rest.marketing.handler.EventHandler$EventTrigger: object
Marketing event trigger. Note : all parameters specified beyond the schema are sent to the marketing event.
- eMarketingSpotId: string
Marketing spot identifier.
- experimentResultTestElementId: string
Experiment result test element identifier.
- baseMarketingSpotActivityID: string
Base marketing spot activity identifier.
- baseMarketingSpotDataType: string
e-Marketing Spot data type for example, "MarketingContent".
- categoryId: string
Category identifier.
- activityId: string
Activity identifier.
- personalizationID: string
Personalization identifier.
- experimentResultId: string
Experiment result identifier.
- searchTerm: string
Search term. Stored in a comma-separated list of search strings.
- DM_ReqCmd: string
Requested command.
- productId: string
Product identifier.
com.ibm.commerce.rest.marketing.handler.SegmentHandler$SegmentMemberCheck: object
Segment membership check.
- isInCustomeSegment: boolean
Is the specified customer in the specified segment.
com.ibm.commerce.rest.order.handler.AssignedCouponHandler$ApplyCouponBody: object
Body of a request to apply a coupon to a shopping cart.
- couponId: string
Coupon identifier.
com.ibm.commerce.rest.order.handler.AssignedCouponHandler$ApplyCouponResponse: object
Body of a response to apply a coupon to a shopping cart.
- orderId: string
Order identifier.
- couponId: string
Coupon identifier.
com.ibm.commerce.rest.order.handler.AssignedCouponHandler$RemoveCouponResponse: object
Body of a response to remove a coupon from a shopping cart.
- orderId: string
Order identifier.
com.ibm.commerce.rest.order.handler.AssignedPromotionCodeHandler$ApplyPromotionCodeBody: object
Body of a request to apply a promotion code to a shopping cart.
- promoCode: string
The promotion code.
com.ibm.commerce.rest.order.handler.AssignedPromotionCodeHandler$ApplyPromotionCodeResponse: object
Body of a response to apply a promotion code to a shopping cart.
- orderId: string
The order identifier.
- promoCode: string
The promotion code.
com.ibm.commerce.rest.order.handler.AssignedPromotionCodeHandler$RemovePromotionCodeResponse: object
Body of a response to remove a promotion code from a shopping cart.
- orderId: string
The order identifier.
com.ibm.commerce.wallet.facade.datatypes.CouponDescriptionType: object
- userData: com.ibm.commerce.wallet.facade.datatypes.CouponDescriptionType.userData
- shortDescription: string
- language: string
- longDescription: string
com.ibm.commerce.wallet.facade.datatypes.CouponDescriptionType.userData: object
- userDataField: object[]
com.ibm.commerce.wallet.facade.datatypes.CouponDescriptionType.userData.userDataField
com.ibm.commerce.wallet.facade.datatypes.CouponDescriptionType.userData.userDataField: object
- value: string
- key: string
coupon-coupon: object
- Coupon: object[]
coupon-coupon_item - recordSetComplete: boolean
- recordSetStartNumber: integer (int64)
- recordSetCount: integer (int64)
- recordSetTotal: integer (int64)
coupon-coupon_item: object
- status: string
- userData: com.ibm.commerce.foundation.common.datatypes.UserDataType
- couponId: string
- couponCode: string
- expirationDateTime: string
- couponDescription: object[]
com.ibm.commerce.wallet.facade.datatypes.CouponDescriptionType - effectiveDateTime: string
- promotion: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType
- order: com.ibm.commerce.foundation.common.datatypes.OrderIdentifierType
Empty: object
Empty model. Used as default value when no model is specified.
espot-ActivityExternalIdentifier: object
- activityIdentifierName: string
- activityIdentifierStoreId: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
espot-ActivityIdentifier: object
- activityExternalIdentifier: espot-ActivityExternalIdentifier
- activityIdentifierID: string
espot-Attachment: object
- attachmentReferenceId: string
- attachmentIdentifier: espot-AttachmentIdentifier
- attachmentReferenceDescription: object[]
espot-AttachmentReferenceDescription - AttachmentReferenceDescription: object[]
espot-Attachment.AttachmentReferenceDescription - AttachmentDescription: object[]
espot-Attachment.AttachmentDescription - attachmentAsset: object[]
espot-AttachmentAsset - attachmentDisplaySequence: string
- userDataField: object[]
espot-Attachment.userDataField - attachmentDescription: object[]
espot-AttachmentDescription - attachmentUsage: espot-AttachmentUsage
espot-Attachment.AttachmentDescription: object
- userDataField: object[]
espot-Attachment.AttachmentDescription.userDataField
espot-Attachment.AttachmentDescription.userDataField: object
- value: string
- key: string
espot-Attachment.AttachmentReferenceDescription: object
- userDataField: object[]
espot-Attachment.AttachmentReferenceDescription.userDataField
espot-Attachment.AttachmentReferenceDescription.userDataField: object
- value: string
- key: string
espot-Attachment.userDataField: object
- value: string
- key: string
espot-AttachmentAsset: object
- attachmentAssetLanguage: string[]
string - attachmentLocalAsset: string
- attachmentAssetMimeType: string
- attachmentAssetRootDirectory: string
- attachmentAssetDirectoryPath: string
- userDataField: object[]
espot-AttachmentAsset.userDataField - attachmentAssetId: string
- attachmentAssetStoreExternalId: com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType
- attachmentAssetStoreId: string
- attachmentAssetPath: string
espot-AttachmentAsset.userDataField: object
- value: string
- key: string
espot-AttachmentDescription: object
- attachmentName: string
- attachmentLanguage: string
- attachmentLongDescription: string
- attachmentShortDescription: string
espot-AttachmentExternalIdentifier: object
- attachementOwnerId: string
- attachementStoreId: string
- attachementStoreExternalId: com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType
- attachementExternalId: string
espot-AttachmentIdentifier: object
- attachementId: string
- attachmentExternalIdentifier: espot-AttachmentExternalIdentifier
espot-AttachmentReferenceDescription: object
- attachmentName: string
- attachmentLanguage: string
- attachmentLongDescription: string
- attachmentShortDescription: string
espot-AttachmentUsage: object
- attachmentDisplaySequence: string
- attachmentUsageName: string
- attachmentUsageDescription: com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType
- attachmentImage: string
espot-BaseMarketingSpotActivityData: object
- activityFormat: string
- activityIdentifier: espot-ActivityIdentifier
- baseMarketingSpotActivityID: string
- baseMarketingSpotDataType: string
- experimentResult: object[]
espot-ExperimentResult - marketingContent: espot-MarketingContent
- activityPriority: string (int64)
- userDataField: object[]
espot-BaseMarketingSpotActivityData.userDataField - baseMarketingSpotActivityName: string
- baseMarketingSpotCampaignName: string
- properties: object[]
espot-BaseMarketingSpotActivityData.properties - catalogGroup: espot-CatalogGroup
- catalogEntry: espot-CatalogEntry
espot-BaseMarketingSpotActivityData.properties: object
- baseMarketingKey: string
- baseMarketingValue: string
espot-BaseMarketingSpotActivityData.userDataField: object
- value: string
- key: string
espot-CatalogEntry: object
- catalogEntryIdentifier: espot-CatalogEntryIdentifier
- standardPrice: espot-StandardPrice
- description: object[]
espot-CatalogEntryDescription - navigationRelationship: object[]
com.ibm.commerce.catalog.facade.datatypes.CatalogEntryNavigationRelationshipType - contractPrice: object[]
espot-ContractPrice - displaySequence: string (double)
- parentCatalogGroupIdentifier: com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType
- kitComponent: object[]
com.ibm.commerce.catalog.facade.datatypes.KitComponentType - sEOURL: object[]
com.ibm.commerce.foundation.common.datatypes.SEOURLType - sEOProperties: object[]
com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType - listPrice: espot-ListPrice
- floorPrice: com.ibm.commerce.foundation.common.datatypes.OfferPriceType
- fulfillmentProperties: com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType
- attachmentReference: object[]
com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType - userDataField: object[]
espot-CatalogEntry.userDataField - attributes: object[]
espot-CatalogEntryAttributes - catalogEntryTypeCode: string
- association: object[]
com.ibm.commerce.catalog.facade.datatypes.AssociationType - navigationPath: string
espot-CatalogEntry.userDataField: object
- value: string
- key: string
espot-CatalogEntryAttributes: object
- searchable: string
- attributeIdentifier: com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType
- attributeType: string
- extendedValue: object[]
java.util.Map$Entry - description: string
- displayable: string
- groupPath: string
- allowedValue: object[]
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType - usage: string
- userDataField: object[]
espot-CatalogEntryAttributes.userDataField - comparable: string
- attributeValue: com.ibm.commerce.catalog.facade.datatypes.AttributeValueType
- floatValue: com.ibm.commerce.catalog.facade.datatypes.FloatValueType
- stringValue: string
- name: string
- language: string
- displaySequence: string (double)
- value: com.ibm.commerce.catalog.facade.datatypes.ValueType
- attributeDataType: string
- values: object[]
com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType - parentAttributeGroup: com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType
- extendedData: object[]
java.util.Map$Entry - integerValue: com.ibm.commerce.catalog.facade.datatypes.IntegerValueType
espot-CatalogEntryAttributes.userDataField: object
- value: string
- key: string
espot-CatalogEntryDescription: object
- keyword: string
- language: string
- fullImage: string
- longDescription: string
- attributes: object[]
java.util.Map$Entry - productName: string
- shortDescription: string
- thumbnail: string
espot-CatalogEntryExternalIdentifier: object
- ownerID: string
- productPartNumber: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
espot-CatalogEntryIdentifier: object
- catalogEntryExternalIdentifier: espot-CatalogEntryExternalIdentifier
- productId: string
espot-CatalogGroup: object
- catalogGroupIdentifier: espot-CatalogGroupIdentifier
- taxonomyAttribute: espot-CatalogGroup.taxonomyAttribute
- description: object[]
espot-CatalogGroupDescription - owningStoreDirectory: string
- displaySequence: number (double)
- parentCatalogGroupIdentifier: espot-CatalogGroup.parentCatalogGroupIdentifier
- breadcrumbLocation: object[]
espot-CatalogGroup.breadcrumbLocation - parentCatalogGroupId: string
- rule: espot-CatalogGroup.rule
- sEOURL: object[]
espot-CatalogGroup.sEOURL - sEOProperties: object[]
espot-CatalogGroup.sEOProperties - attachmentReference: object[]
espot-CatalogGroup.attachmentReference - dynamicCatalogGroup: integer (int32)
- externalContentReference: object[]
espot-CatalogGroup.externalContentReference - navigationRelationship: object[]
espot-CatalogGroup.navigationRelationship - attributes: object[]
espot-CatalogGroup.attributes - facet: object[]
espot-CatalogGroup.facet - topCatalogGroup: boolean
- association: object[]
espot-CatalogGroup.association - navigationPath: string
espot-CatalogGroup.association: object
- catalogGroupReference: espot-CatalogGroup.association.catalogGroupReference
- name: string
- catalogEntryReference: espot-CatalogGroup.association.catalogEntryReference
- associationCodeType: string
- displaySequence: number (double)
- associatedObject: espot-CatalogGroup.association.associatedObject
- uniqueID: string
- externalSource: boolean
- attributes: object[]
espot-CatalogGroup.association.attributes - associatedObjectGroup: object[]
Empty - semantic: string
- quantity: number (double)
espot-CatalogGroup.association.associatedObject: object
espot-CatalogGroup.association.attributes: object
- value: string
- key: string
espot-CatalogGroup.association.catalogEntryReference: object
- catalogEntryIdentifier: espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier
- displayName: string
- catalogEntryTypeCode: string
- navigationPath: string
espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier
espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier
espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.association.catalogGroupReference: object
- catalogGroupIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier
- displayName: string
- catalogIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier
- navigationPath: string
espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier
espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier: object
- ownerID: string
- storeIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier
- groupIdentifier: string
espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier
espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier: object
- ownerID: string
- identifier: string
- storeIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier
espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.attachmentReference: object
- userData: espot-CatalogGroup.attachmentReference.userData
- attachmentIdentifier: espot-CatalogGroup.attachmentReference.attachmentIdentifier
- attachmentReferenceIdentifier: espot-CatalogGroup.attachmentReference.attachmentReferenceIdentifier
- displaySequence: string
- attachmentReferenceDescription: object[]
espot-CatalogGroup.attachmentReference.attachmentReferenceDescription - attachmentAsset: object[]
espot-CatalogGroup.attachmentReference.attachmentAsset - attachmentDescription: object[]
espot-CatalogGroup.attachmentReference.attachmentDescription - attachmentUsage: espot-CatalogGroup.attachmentReference.attachmentUsage
espot-CatalogGroup.attachmentReference.attachmentAsset: object
- mimeType: string
- attachmentAssetIdentifier: espot-CatalogGroup.attachmentReference.attachmentAsset.attachmentAssetIdentifier
- rootDirectory: string
- language: string[]
string - directoryPath: string
- storeIdentifier: espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier
- localAsset: boolean
- userData: espot-CatalogGroup.attachmentReference.attachmentAsset.userData
- attachmentAssetPath: string
espot-CatalogGroup.attachmentReference.attachmentAsset.attachmentAssetIdentifier: object
- uniqueID: string
espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier.externalIdentifier
espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.attachmentReference.attachmentAsset.userData: object
- userDataField: object[]
espot-CatalogGroup.attachmentReference.attachmentAsset.userData.userDataField
espot-CatalogGroup.attachmentReference.attachmentAsset.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.attachmentReference.attachmentDescription: object
- userData: espot-CatalogGroup.attachmentReference.attachmentDescription.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
espot-CatalogGroup.attachmentReference.attachmentDescription.userData: object
- userDataField: object[]
espot-CatalogGroup.attachmentReference.attachmentDescription.userData.userDataField
espot-CatalogGroup.attachmentReference.attachmentDescription.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.attachmentReference.attachmentIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier
espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier: object
- ownerID: string
- identifier: string
- storeIdentifier: espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier
espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.attachmentReference.attachmentReferenceDescription: object
- userData: espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData: object
- userDataField: object[]
espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData.userDataField
espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.attachmentReference.attachmentReferenceIdentifier: object
- uniqueID: string
espot-CatalogGroup.attachmentReference.attachmentUsage: object
- displaySequence: string
- attachmentUsageDescription: espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription
- image: string
- usageName: string
espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription: object
- userData: espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData
- shortDescription: string
- name: string
- language: string
- longDescription: string
espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData: object
- userDataField: object[]
espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData.userDataField
espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.attachmentReference.userData: object
- userDataField: object[]
espot-CatalogGroup.attachmentReference.userData.userDataField
espot-CatalogGroup.attachmentReference.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.attributes: object
- value: string
- key: string
espot-CatalogGroup.breadcrumbLocation: object
- catalogGroupUniqueID: string[]
string
espot-CatalogGroup.externalContentReference: object
- externalContentAsset: object[]
espot-CatalogGroup.externalContentReference.externalContentAsset - externalContentDescription: string
- externalContentIdentifier: string
- externalContentType: string
- language: string
- lastUpdateTime: string
- name: string
- uniqueID: string
- userData: espot-CatalogGroup.externalContentReference.userData
espot-CatalogGroup.externalContentReference.externalContentAsset: object
- assetFullPath: string
- assetPath: string
- externalContentIdentifier: string
- mimeType: string
- name: string
- userData: espot-CatalogGroup.externalContentReference.externalContentAsset.userData
espot-CatalogGroup.externalContentReference.externalContentAsset.userData: object
- userDataField: object[]
espot-CatalogGroup.externalContentReference.externalContentAsset.userData.userDataField
espot-CatalogGroup.externalContentReference.externalContentAsset.userData.userDataField: object
- key: string
- value: string
espot-CatalogGroup.externalContentReference.userData: object
- userDataField: object[]
espot-CatalogGroup.externalContentReference.userData.userDataField
espot-CatalogGroup.externalContentReference.userData.userDataField: object
- key: string
- value: string
espot-CatalogGroup.facet: object
- attribute: espot-CatalogGroup.facet.attribute
- facetIdentifier: espot-CatalogGroup.facet.facetIdentifier
espot-CatalogGroup.facet.attribute: object
- attributeDescription: object[]
espot-CatalogGroup.facet.attribute.attributeDescription
espot-CatalogGroup.facet.attribute.attributeDescription: object
- userData: espot-CatalogGroup.facet.attribute.attributeDescription.userData
- name: string
- description: string
- language: string
- extendedData: object[]
espot-CatalogGroup.facet.attribute.attributeDescription.extendedData
espot-CatalogGroup.facet.attribute.attributeDescription.extendedData: object
- value: string
- key: string
espot-CatalogGroup.facet.attribute.attributeDescription.userData: object
- userDataField: object[]
espot-CatalogGroup.facet.attribute.attributeDescription.userData.userDataField
espot-CatalogGroup.facet.attribute.attributeDescription.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.facet.facetIdentifier: object
- identifier: string
- uniqueID: string
espot-CatalogGroup.navigationRelationship: object
- attributes: object[]
espot-CatalogGroup.navigationRelationship.attributes - displaySequence: number (double)
- catalogGroupReference: espot-CatalogGroup.navigationRelationship.catalogGroupReference
- type: string
- catalogEntryReference: espot-CatalogGroup.navigationRelationship.catalogEntryReference
espot-CatalogGroup.navigationRelationship.attributes: object
- value: string
- key: string
espot-CatalogGroup.navigationRelationship.catalogEntryReference: object
- catalogEntryIdentifier: espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier
- displayName: string
- catalogEntryTypeCode: string
- navigationPath: string
espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier
espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier
espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.navigationRelationship.catalogGroupReference: object
- catalogGroupIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier
- displayName: string
- catalogIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier
- navigationPath: string
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier: object
- ownerID: string
- storeIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier
- groupIdentifier: string
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier: object
- ownerID: string
- identifier: string
- storeIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.parentCatalogGroupIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier
espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier: object
- ownerID: string
- storeIdentifier: espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier
- groupIdentifier: string
espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.rule: object
- userData: object[]
espot-CatalogGroup.rule.userData - nVP: object[]
espot-CatalogGroup.rule.nVP - uniqueID: string
- element: object[]
espot-CatalogGroup.rule.element
espot-CatalogGroup.rule.element: object
- userData: object[]
espot-CatalogGroup.rule.element.userData - type: string
- uniqueID: string
- nVP: object[]
espot-CatalogGroup.rule.element.nVP
espot-CatalogGroup.rule.element.nVP: object
- value: string
- key: string
espot-CatalogGroup.rule.element.userData: object
- value: string
- key: string
espot-CatalogGroup.rule.nVP: object
- value: string
- key: string
espot-CatalogGroup.rule.userData: object
- userDataField: object[]
espot-CatalogGroup.rule.userData.userDataField
espot-CatalogGroup.rule.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.sEOProperties: object
- resolved: boolean
- userData: espot-CatalogGroup.sEOProperties.userData
- language: string
- metaKeyword: string
- fullImageAltDescription: string
- parentStoreIdentifier: espot-CatalogGroup.sEOProperties.parentStoreIdentifier
- pageGroup: string
- objectIdentifier: string
- sEOPageDefID: string
- title: string
- metaDescription: string
espot-CatalogGroup.sEOProperties.parentStoreIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.sEOProperties.parentStoreIdentifier.externalIdentifier
espot-CatalogGroup.sEOProperties.parentStoreIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.sEOProperties.userData: object
- userDataField: object[]
espot-CatalogGroup.sEOProperties.userData.userDataField
espot-CatalogGroup.sEOProperties.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.sEOURL: object
- userData: espot-CatalogGroup.sEOURL.userData
- parentStoreIdentifier: espot-CatalogGroup.sEOURL.parentStoreIdentifier
- tokenValue: string
- uRLKeywordID: string
- uRLKeyword: object[]
espot-CatalogGroup.sEOURL.uRLKeyword - usage: string
- siteMapInfo: espot-CatalogGroup.sEOURL.siteMapInfo
espot-CatalogGroup.sEOURL.parentStoreIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.sEOURL.parentStoreIdentifier.externalIdentifier
espot-CatalogGroup.sEOURL.parentStoreIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.sEOURL.siteMapInfo: object
- priority: number (double)
- userData: espot-CatalogGroup.sEOURL.siteMapInfo.userData
- mobilePriority: number (double)
- changeFrequency: string
- mobileChangeFrequency: string
espot-CatalogGroup.sEOURL.siteMapInfo.userData: object
- userDataField: object[]
espot-CatalogGroup.sEOURL.siteMapInfo.userData.userDataField
espot-CatalogGroup.sEOURL.siteMapInfo.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.sEOURL.uRLKeyword: object
- userData: espot-CatalogGroup.sEOURL.uRLKeyword.userData
- keyword: string
- language: string
- generatedMobileKeyword: string
- uRLPrefix: string
- mobileURLPrefix: string
- previewURL: string
- mobileKeyword: string
- generatedKeyword: string
- previewMobileURL: string
espot-CatalogGroup.sEOURL.uRLKeyword.userData: object
- userDataField: object[]
espot-CatalogGroup.sEOURL.uRLKeyword.userData.userDataField
espot-CatalogGroup.sEOURL.uRLKeyword.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.sEOURL.userData: object
- userDataField: object[]
espot-CatalogGroup.sEOURL.userData.userDataField
espot-CatalogGroup.sEOURL.userData.userDataField: object
- value: string
- key: string
espot-CatalogGroup.taxonomyAttribute: object
- attribute: object[]
espot-CatalogGroup.taxonomyAttribute.attribute
espot-CatalogGroup.taxonomyAttribute.attribute: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier: object
- attributeDictionaryIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier
- storeIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier
- identifier: string
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier: object
- storeIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier
- identifier: string
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier.externalIdentifier
espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
espot-CatalogGroupDescription: object
- categoryName: string
- language: string
- fullImage: string
- longDescription: string
- keyword: string
- attributes: object[]
java.util.Map$Entry - shortDescription: string
- thumbnail: string
espot-CatalogGroupExternalIdentifier: object
- ownerID: string
- categoryIdentifier: string
- categoryGroupId: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
espot-CatalogGroupIdentifier: object
- catalogGroupExternalIdentifier: espot-CatalogGroupExternalIdentifier
- categoryId: string
espot-ContractExternalIdentifier: object
- majorVersionNumber: string (int32)
- origin: string
- minorVersionNumber: string (int32)
- name: string
- ownerID: string
espot-ContractIdentifier: object
- contractExternalIdentifier: espot-ContractExternalIdentifier
- contractID: string
espot-ContractPrice: object
- lastUpdate: string
- endDate: string
- description: com.ibm.commerce.foundation.common.datatypes.DescriptionType
- precedence: string (double)
- quantityUnit: string
- contractIdentifier: espot-ContractIdentifier
- maximumQuantity: string (double)
- minimumQuantity: string (double)
- contractUnitPrice: espot-ContractUnitPrice
- startDate: string
- userDataField: object[]
espot-ContractPrice.userDataField - qualifier: string
espot-ContractPrice.userDataField: object
- value: string
- key: string
espot-ContractUnitPrice: object
- currency: string
- quantity: com.ibm.commerce.foundation.common.datatypes.QuantityType
- contractPrice: string (double)
- alternativeCurrencyPrice: object[]
com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType
espot-DefaultContentDisplaySequence: object
- displaySequence: string
- resultId: string
- resultFormat: string
espot-espot: object
- MarketingSpotData: object[]
espot-espot_item
espot-espot_item: object
- nextTimeLimit: string (int64)
- marketingSpotIdentifier: espot-MarketingSpotIdentifier
- baseMarketingSpotActivityData: object[]
espot-BaseMarketingSpotActivityData - filteredResult: object[]
espot-espot_item.filteredResult - defaultContentDisplaySequence: object[]
espot-DefaultContentDisplaySequence - marketingSpotDataTitle: object[]
espot-MarketingSpotDataTitle - behavior: string
- previewReport: string[]
string
espot-espot_item.filteredResult: object
- filteredResultId: string
- filteredResultFormat: string
espot-Experiment: object
- experimentResultName: string
- experimentResultId: string
espot-ExperimentResult: object
- controlElement: string
- experiment: espot-Experiment
- testElement: espot-TestElement
espot-ListPrice: object
- listPriceAltCurrencyPrice: object[]
com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType - listPriceCurrency: string
- listPrice: string (double)
- listPriceQuantity: com.ibm.commerce.foundation.common.datatypes.QuantityType
espot-MarketingContent: object
- contentUrl: string
- marketingContentIdentifier: espot-MarketingContentIdentifier
- contentFormatName: string
- marketingContentImageMap: object[]
espot-MarketingContentImageMap - marketingContentDescription: object[]
espot-MarketingContentDescription - contentMimeType: string
- contentInputOption: string , x ∈ { Area , Source }
- MarketingContentDescription: object[]
espot-MarketingContent.MarketingContentDescription - attachment: espot-Attachment
- contentFormatId: string
- userDataField: object[]
espot-MarketingContent.userDataField - contentClickAction: string , x ∈ { None , Single , Multiple }
espot-MarketingContent.MarketingContentDescription: object
- userDataField: object[]
espot-MarketingContent.MarketingContentDescription.userDataField
espot-MarketingContent.MarketingContentDescription.userDataField: object
- value: string
- key: string
espot-MarketingContent.userDataField: object
- value: string
- key: string
espot-MarketingContentDescription: object
- marketingText: string
- contentLocation: string
- language: string
espot-MarketingContentExternalIdentifier: object
- contentName: string
- contentStoreExternalId: com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType
- contentStoreId: string
espot-MarketingContentIdentifier: object
- contentId: string
- marketingContentExternalIdentifier: espot-MarketingContentExternalIdentifier
espot-MarketingContentImageMap: object
- source: string
- userDataField: object[]
espot-MarketingContentImageMap.userDataField - name: string
- area: object[]
com.ibm.commerce.marketing.facade.datatypes.AreaType
espot-MarketingContentImageMap.userDataField: object
- value: string
- key: string
espot-MarketingSpotDataTitle: object
- experimentResult: object[]
espot-ExperimentResult - marketingContent: espot-MarketingContent
- marketingSpotDataTitleDataType: string
- marketingSpotDataTitleName: string
- marketingSpotDataTitleId: string
- marketingSpotDataTitleActivityID: string
espot-MarketingSpotExternalIdentifier: object
- eSpotStoreId: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
- eSpotName: string
espot-MarketingSpotIdentifier: object
- marketingSpotExternalIdentifier: espot-MarketingSpotExternalIdentifier
- marketingSpotIdentifier: string
espot-StandardPrice: object
- standardPriceContractID: com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType
- standardPriceStartDate: string
- standardPricePrecedence: string (double)
- standardPriceQualifier: string
- standardUnitPrice: espot-StandardUnitPrice
- standardPriceMaxQuantity: string (double)
- standardPriceEndDate: string
- standardPriceQuantityUnit: string
- userDataField: object[]
espot-StandardPrice.userDataField - standardPriceDescription: com.ibm.commerce.foundation.common.datatypes.DescriptionType
- standardPriceLastUpdate: string
- standardPriceMinQuantity: string (double)
espot-StandardPrice.userDataField: object
- value: string
- key: string
espot-StandardUnitPrice: object
- standardPriceQuantity: com.ibm.commerce.foundation.common.datatypes.QuantityType
- standardPrice: string (double)
- standardPriceAltCurrencyPrice: object[]
com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType - standardPriceCurrency: string
espot-TestElement: object
- experimentResultTestElementId: string
- experimentResultTestElementName: string
java.util.Map$Entry: object
- value: string
- key: string
promotion-promotion: object
- recordSetCount: integer (int64)
- recordSetComplete: boolean
- Promotion: object[]
promotion-promotion_item - recordSetStartNumber: integer (int64)
- recordSetTotal: integer (int64)
promotion-promotion_item: object
- status: string
- storeId: string
- Description: object[]
promotion-promotion_item.Description - schedule: com.ibm.commerce.promotion.facade.datatypes.PromotionScheduleType
- promotionName: string
- administrativeName: string
- promotionType: string
- promotionId: string
promotion-promotion_item.Description: object
- shortDescription: string
- longDescription: string
segment-segments: object
- recordSetCount: integer (int64)
- recordSetComplete: boolean
- recordSetStartNumber: integer (int64)
- MemberGroup: object[]
segment-segments_item - recordSetTotal: integer (int64)
segment-segments_item: object
- usage: string[]
string - displayName: com.ibm.commerce.foundation.common.datatypes.DescriptionType
- description: com.ibm.commerce.foundation.common.datatypes.DescriptionType
- id: string
spot-spot: object
- recordSetCount: integer (int64)
- recordSetComplete: boolean
- recordSetStartNumber: integer (int64)
- MarketingSpot: object[]
spot-spot_item - recordSetTotal: integer (int64)
spot-spot_item: object
- spotName: string
- description: string
- spotId: string
- userDataField: object[]
spot-spot_item.userDataField - type: string
- uiDisplayable: integer (int64)
spot-spot_item.userDataField: object
- value: string
- key: string