{ "openapi": "3.0.1", "info": { "title": "Marketing", "description": "Provide APIs related to marketing in either a B2B or B2C store. Use these services to: ", "version": "9.1.20.0", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/wcs/resources", "variables": { "port": { "default": "443", "enum": [ "443", "5443" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "externalDocs": { "description": "Some REST services require authentication. HCL Commerce REST services are authenticated on secure and unsecured channels. This authentication can include the use of the WCToken and WCTrustedToken. To use REST services that require authentication, you must first get authentication data by using a supported identity services.\n\nAfter you obtain the authentication data, you must pass either the WCToken or WCTustedToken parameters, or both, within the HTTP header for every request that requires authentication. If a request is sent over HTTP, pass the WCToken parameter in the HTTP header. Do not pass the WCTrustedToken in HTTP requests, as the parameter value might display. Send both the WCToken and the WCTrustedToken parameters when the request is being sent over HTTPS.\n\nThe HCL Commerce REST APIs can also use session cookies that are created by the HCL Commerce store runtime for authentication. These cookies allow you to mix requests to the HCL Commerce REST APIs and the HCL Commerce store runtime within the same user session.\n\n", "url": "https://help.hcltechsw.com/commerce/9.1.0/webservices/concepts/cwvrestauth.html?hl=rest%2Cauthentication" }, "tags": [ { "name": "Spot", "description": "Provides RESTful services to retrieve spot details." }, { "name": "Event", "description": "Provides RESTful services to trigger marketing based on certain types of events. For example, CategoryDisplay, ProductDisplay, or Search." }, { "name": "Segment", "description": "Provides RESTful services to retrieve the customer segment data" }, { "name": "User Behavior", "description": "Provides RESTful services to get and delete user behavior for marketing purposes." } ], "paths": { "/store/{storeId}/spot/{spotId}": { "get": { "tags": [ "Spot" ], "summary": "Get e-Marketing Spots by unique identifier", "description": "Gets an e-Marketing Spot in a store using its unique identifier.", "operationId": "Spot-findSpotByID", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "spotId", "in": "path", "description": "E-Spot identifier.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } }, { "name": "pageNumber", "in": "query", "description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/spot-spot" }, "example": { "resourceId": "https://localhost:443/wcs/resources/store/1/spot/10011", "recordSetStartNumber": 0, "recordSetComplete": true, "MarketingSpot": [ { "spotName": "AboutDressDesignerPageMainAd", "spotId": "10011", "type": "MARKETING", "description": "Display the main ad on About Dress Designer page", "uiDisplayable": 1 } ], "recordSetCount": 1, "resourceName": "spot", "recordSetTotal": 1 } }, "application/xml": { "schema": { "$ref": "#/components/schemas/spot-spot" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/spot-spot" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/spot-spot" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/event/click_info": { "post": { "tags": [ "Event" ], "summary": "Handle click information", "description": "Handles click information.", "operationId": "Event-handleClickInfo", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "requestBody": { "description": "Marketing evaluate trigger body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.EventHandler-EventTrigger-clickinfo" } } }, "required": false }, "responses": { "202": { "description": "The requested completed successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/{storeId}/event/update_marketing_tracking_consent": { "post": { "tags": [ "Event" ], "summary": "Update the marketing tracking consent for a user for the store.", "description": "Update the marketing tracking consent for a user for the store.", "operationId": "Event-updateMarketingTrackingConsent", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "requestBody": { "description": "Marketing evaluate trigger body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.EventHandler-MarketingTrackingConsent" } } }, "required": false }, "responses": { "200": { "description": "The requested completed successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/{storeId}/segment/{segmentId}": { "get": { "tags": [ "Segment" ], "summary": "Get segment by the segment ID", "description": "Gets customer segment by segmentId.", "operationId": "getCustomerSegmentById", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "segmentId", "in": "path", "description": "The segment identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segment-segments" }, "example": { "resourceId": "https://localhost:443/wcs/resources/store/1/segment/8000000000000002002", "recordSetStartNumber": 0, "recordSetComplete": true, "recordSetCount": 1, "MemberGroup": [ { "usage": [ "GeneralPurpose" ], "displayName": { "language": -1, "value": "Guest Shoppers" }, "description": { "language": -1, "value": "Shoppers who have not registered with the store" }, "id": "8000000000000000003" } ], "resourceName": "segment", "recordSetTotal": 1 } }, "application/xml": { "schema": { "$ref": "#/components/schemas/segment-segments" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/segment-segments" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/segment-segments" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/espot/{name}/type/{type}": { "get": { "tags": [ "Spot" ], "summary": "Get e-Marketing Sport data", "description": "Gets e-Marketing Spot data.", "operationId": "E-spot-findESpotData", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "path", "description": "E-Spot name.", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "description": "E-Marketing Spot type for example, SEARCH.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } }, { "name": "catalogId", "in": "query", "description": "The catalog identifier. If none is specified, the store default catalog is used.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.", "schema": { "type": "string" }, "example": "USD" }, { "name": "name", "in": "query", "description": "E-Spot name.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/espot-espot" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/espot-espot" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/espot-espot" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/espot-espot" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/spot": { "get": { "tags": [ "Spot" ], "summary": "Get e-Marketing Spots", "description": "Gets e-Marketing Spots in a store.", "operationId": "Spot-findSpotsByQuery", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "The query name.", "required": true, "schema": { "type": "string", "enum": [ "byType", "byTypeAndName" ] } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } }, { "name": "qType", "in": "query", "description": "Type of the e-spot. For instance : qType=MARKETING or STOREFEATURE Required for search by type.", "schema": { "type": "string" } }, { "name": "qName", "in": "query", "description": "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.", "schema": { "type": "string" } }, { "name": "catalogId", "in": "query", "description": "The catalog identifier. If none is specified, the store default catalog is used.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/spot-spot" }, "example": { "resourceId": "https://localhost:443/wcs/resources/store/1/spot?q=byType&qType=STOREFEATURE", "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetComplete": true, "MarketingSpot": [ { "spotName": "AboutDressDesignerPageMainAd", "spotId": "10011", "type": "STOREFEATURE", "description": "Display the main ad on About Dress Designer page", "userDataField": [ { "value": "string", "key": "string" } ], "uiDisplayable": 1 } ], "resourceName": "spot", "recordSetTotal": 1 } }, "application/xml": { "schema": { "$ref": "#/components/schemas/spot-spot" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/spot-spot" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/spot-spot" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/event": { "post": { "tags": [ "Event" ], "summary": "Trigger marketing by event", "description": "Triggers marketing based on certain events.", "operationId": "Event-triggerMarketing", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "requestBody": { "description": "Marketing event trigger body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.EventHandler-EventTrigger" } } }, "required": false }, "responses": { "200": { "description": "The requested completed successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/{storeId}/espot/{name}/product/{productId}": { "get": { "tags": [ "Spot" ], "summary": "Get e-Marketing Sport for product", "description": "\"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.\"", "operationId": "E-spot-findByNameWithProduct", "parameters": [ { "name": "name", "in": "path", "description": "E-Spot name.", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "description": "The product identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } }, { "name": "catalogId", "in": "query", "description": "The catalog identifier. If none is specified, the store default catalog is used.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.", "schema": { "type": "string" }, "example": "USD" } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" }, "example": { "resourceId": "http://localhost:443/wcs/resources/store/2/espot/espot/product/10040", "MarketingSpotData": [ { "nextTimeLimit": -1, "eSpotName": "ESpotDataHandlerESpotName", "marketingSpotIdentifier": "15562", "behavior": "0" } ], "resourceName": "espot" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/espot/{name}/category/{categoryId}": { "get": { "tags": [ "Spot" ], "summary": "Get e-Marketing Spot by category", "description": "\"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.\"", "parameters": [ { "name": "name", "in": "path", "description": "E-Spot name.", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" }, "example": "1, 2, 10001" }, { "name": "categoryId", "in": "path", "description": "The category identifier.", "schema": { "type": "string" }, "required": true }, { "name": "responseFormat", "in": "query", "description": "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json.", "required": false, "schema": { "type": "string", "enum": [ "xml", "json" ] } }, { "name": "catalogId", "in": "query", "description": "The catalog identifier. If none is specified, the store default catalog shall be used.", "schema": { "type": "string" }, "required": false }, { "name": "currency", "in": "query", "description": "The currency code to use. Example usage : currency=USD. If no currency code is specified, the store default currency shall be used.", "required": false, "schema": { "type": "string" }, "example": "USD" } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/event/behavior_rules": { "get": { "tags": [ "Event" ], "summary": "Get user behavior rules", "description": "Gets user behavior rules.", "operationId": "Event-getBehaviorRules", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/behavior_rules-behavior_rules" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/behavior_rules-behavior_rules" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/behavior_rules-behavior_rules" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/behavior_rules-behavior_rules" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/espot/{name}": { "get": { "tags": [ "Spot" ], "summary": "Get e-Marketing Spot by name", "description": "Gets an e-Marketing Spot by name.", "operationId": "E-spot-findByName", "parameters": [ { "name": "name", "in": "path", "description": "E-Spot name.", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } }, { "name": "catalogId", "in": "query", "description": "The catalog identifier. If none is specified, the store default catalog is used.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.", "schema": { "type": "string" }, "example": "USD" }, { "name": "name", "in": "query", "description": "E-Spot name.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" }, "example": { "resourceId": "http://localhost:443/wcs/resources/store/2/espot/espot", "MarketingSpotData": [ { "nextTimeLimit": -1, "marketingSpotIdentifier": "10562", "baseMarketingSpotActivityData": [ { "baseMarketingSpotActivityID": "10065", "baseMarketingSpotDataType": "MarketingContent", "MarketingContentDescription": [ {} ], "contentId": "10065", "activityPriority": "1", "contentFormatName": "Text", "activityIdentifierID": "0", "marketingContentDescription": [ { "marketingText": "
Kids' Stuff
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.
*Before taxes. Gift certificates are redeemable on your next visit.
shop now
\"\" \"\"
", "language": -1 } ], "contentClickAction": "None", "contentName": "HomeKidsApparelAdContent", "baseMarketingSpotActivityName": "HomeKidsApparelAdContent", "contentFormatId": "2", "properties": [ { "baseMarketingKey": "mktActivityDescription" }, { "baseMarketingKey": "displaySequence", "baseMarketingValue": "1.0" } ], "contentStoreId": "10001" } ], "defaultContentDisplaySequence": [ { "displaySequence": "1.0", "resultId": "10065", "resultFormat": "MarketingContent" } ], "eSpotName": "HomeBottomRight_Content", "behavior": "0" } ], "resourceName": "espot" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/segment/{segmentId}/isMember": { "get": { "tags": [ "Segment" ], "summary": "Check segment membership", "description": "Checks if the customer identified by userId or personalizationId is part of given customer segment.", "operationId": "checkIsInSegmentByUserId", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "segmentId", "in": "path", "description": "Segment identifier.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "User unique identifier.", "schema": { "type": "integer", "format": "int32" } }, { "name": "personalizationId", "in": "query", "description": "The user's personalization id. Note : this parameter is ignored if the userId parameter is specified.", "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.SegmentHandler-SegmentMemberCheck" }, "example": { "isInCustomeSegment": true, "resourceName": "segment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.SegmentHandler-SegmentMemberCheck" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.SegmentHandler-SegmentMemberCheck" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.SegmentHandler-SegmentMemberCheck" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/espot": { "get": { "tags": [ "Spot" ], "summary": "Get search terms with search rules", "description": "Gets all search terms that have search rules.", "operationId": "E-spot-findAllSearchTerms", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "The query name.", "required": true, "schema": { "type": "string", "enum": [ "allSearchTerms" ] } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-SearchTermsContainer" }, "example": { "resourceId": "https://localhost:443/wcs/resources/store/2/espot?q=allSearchTerms", "searchTerms": "", "resourceName": "espot" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-SearchTermsContainer" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-SearchTermsContainer" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-SearchTermsContainer" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/event/evaluate_triggers": { "post": { "tags": [ "Event" ], "summary": "Evaluate triggers", "description": "Evaluates potential triggers passed from the store.", "operationId": "Event-evaluateTriggers", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "requestBody": { "description": "Marketing evaluate trigger body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.EventHandler-EventTrigger" } } }, "required": false }, "responses": { "200": { "description": "The requested completed successfully." }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/{storeId}/segment": { "get": { "tags": [ "Segment" ], "summary": "Get segments by user or store ID", "description": "Gets all customer segments by a specified storeId or get segment by userId or personalizationId or byName.", "operationId": "getCustomerSegments", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "The query name.", "required": true, "schema": { "type": "string", "enum": [ "byUserId", "byPersonalizationId", "byName", "all" ] } }, { "name": "qUserId", "in": "query", "description": "The user identifier. Required if the query is set to byUserId.", "schema": { "type": "integer", "format": "int32" } }, { "name": "qPersonalizationId", "in": "query", "description": "The user's personalization identifier. Required if the query is set to byPersonalizationId.", "schema": { "type": "string" } }, { "name": "qName", "in": "query", "description": "The user's name. Required if the query is set to byName.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.", "schema": { "type": "integer", "format": "int32" } }, { "name": "responseFormat", "in": "query", "description": "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.", "schema": { "type": "string", "enum": [ "xml", "json" ] } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segment-segments" }, "example": { "resourceId": "https://localhost:443/wcs/resources/store/2/segment?q=all", "recordSetStartNumber": 0, "recordSetComplete": true, "recordSetCount": 1, "MemberGroup": [ { "usage": [ "GeneralPurpose" ], "displayName": { "language": -1, "value": "Guest Shoppers" }, "description": { "language": -1, "value": "Shoppers who have not registered with the store" }, "id": "8000000000000002003" } ], "resourceName": "segment", "recordSetTotal": 1 } }, "application/xml": { "schema": { "$ref": "#/components/schemas/segment-segments" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/segment-segments" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/segment-segments" } } } }, "400": { "description": "Bad request. The request could not be understood by the server due to malformed syntax.", "content": {} }, "401": { "description": "Not authenticated. The user session is not valid.", "content": {} }, "403": { "description": "The user is not authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource could not be found.", "content": {} }, "500": { "description": "Internal server error. For details, see the server log files.", "content": {} } } } }, "/store/{storeId}/user_behavior/{userId}": { "delete": { "tags": [ "User Behavior" ], "summary": "Delete the marketing tracking data for a user for the store.", "operationId": "deleteUserBehaviorData", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string", "enum": [ "0", "10001", "10501", "11001", "1" ] } }, { "name": "userId", "in": "path", "description": "The user ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/store/{storeId}/user_behavior": { "get": { "tags": [ "User Behavior" ], "summary": "Get the marketing tracking data for a user for the store.", "operationId": "findUserBehaviors", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string", "enum": [ "0", "10001", "10501", "11001", "1" ] } }, { "name": "userId", "in": "query", "description": "The user ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.marketing.beans.UserBehaviorListDataBean_IBM_Admin_Summary" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.marketing.beans.UserBehaviorListDataBean_IBM_Admin_Summary" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } } }, "components": { "schemas": { "espot-ActivityIdentifier": { "type": "object", "properties": { "activityExternalIdentifier": { "$ref": "#/components/schemas/espot-ActivityExternalIdentifier" }, "activityIdentifierID": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute": { "type": "object", "properties": { "attribute": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute" } } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier": { "required": [ "partNumber" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "partNumber": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier" }, "identifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-TestElement": { "required": [ "experimentResultTestElementId" ], "type": "object", "properties": { "experimentResultTestElementId": { "type": "string" }, "experimentResultTestElementName": { "type": "string" } } }, "espot-CatalogGroup.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOProperties": { "type": "object", "properties": { "resolved": { "type": "boolean" }, "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOProperties.userData" }, "language": { "type": "string" }, "metaKeyword": { "type": "string" }, "fullImageAltDescription": { "type": "string" }, "parentStoreIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOProperties.parentStoreIdentifier" }, "pageGroup": { "type": "string" }, "objectIdentifier": { "type": "string" }, "sEOPageDefID": { "type": "string" }, "title": { "type": "string" }, "metaDescription": { "type": "string" } } }, "espot-CatalogGroup.sEOProperties.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.rule.nVP": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier" }, "groupIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData.userDataField" } } } }, "espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier" }, "groupIdentifier": { "type": "string" } } }, "espot-Attachment.AttachmentReferenceDescription.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-MarketingContent": { "type": "object", "properties": { "contentUrl": { "type": "string" }, "marketingContentIdentifier": { "$ref": "#/components/schemas/espot-MarketingContentIdentifier" }, "contentFormatName": { "type": "string" }, "marketingContentImageMap": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingContentImageMap" } }, "MarketingContentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingContent.MarketingContentDescription" } }, "marketingContentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingContentDescription" } }, "contentInputOption": { "type": "string", "enum": [ "Area", "Source" ] }, "contentMimeType": { "type": "string" }, "attachment": { "$ref": "#/components/schemas/espot-Attachment" }, "contentFormatId": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingContent.userDataField" } }, "contentClickAction": { "type": "string", "enum": [ "None", "Single", "Multiple" ] } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.extendedValue": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-MarketingSpotDataTitleContainer-MarketingContentImageMapContainer": { "type": "object", "properties": { "source": { "type": "string", "description": "HTML definition of the image map. This element is used when users want to define the whole image map directly using HTML." }, "name": { "type": "string", "description": "Name of the image map." }, "area": { "type": "array", "description": "Clickable area in the image map.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-MarketingSpotDataTitleContainer-MarketingContentImageMapContainer-AreaTypeContainer" } } }, "description": "Structure containing image map definition for marketing content." }, "espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.facet.attribute.attributeDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.facet.attribute.attributeDescription.userData.userDataField" } } } }, "espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-CatalogEntryDescription": { "type": "object", "properties": { "keyword": { "type": "string" }, "language": { "type": "string" }, "fullImage": { "type": "string" }, "longDescription": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/java.util.Map-Entry" } }, "productName": { "type": "string" }, "shortDescription": { "type": "string" }, "thumbnail": { "type": "string" } } }, "espot-MarketingContent.MarketingContentDescription.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.facet": { "required": [ "attribute", "facetIdentifier" ], "type": "object", "properties": { "attribute": { "$ref": "#/components/schemas/espot-CatalogGroup.facet.attribute" }, "facetIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.facet.facetIdentifier" } } }, "espot-CatalogGroup.sEOURL.siteMapInfo": { "type": "object", "properties": { "priority": { "type": "number", "format": "double" }, "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.siteMapInfo.userData" }, "mobilePriority": { "type": "number", "format": "double" }, "changeFrequency": { "type": "string" }, "mobileChangeFrequency": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentAsset": { "required": [ "attachmentAssetPath" ], "type": "object", "properties": { "mimeType": { "type": "string" }, "attachmentAssetIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentAsset.attachmentAssetIdentifier" }, "rootDirectory": { "type": "string" }, "language": { "type": "array", "items": { "type": "string" } }, "directoryPath": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentAsset.storeIdentifier" }, "localAsset": { "type": "boolean" }, "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentAsset.userData" }, "attachmentAssetPath": { "type": "string" } } }, "espot-CatalogEntryAttributes": { "required": [ "stringValue" ], "type": "object", "properties": { "searchable": { "type": "string" }, "attributeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType" }, "attributeType": { "type": "string" }, "extendedValue": { "type": "array", "items": { "$ref": "#/components/schemas/java.util.Map-Entry" } }, "description": { "type": "string" }, "displayable": { "type": "string" }, "groupPath": { "type": "string" }, "allowedValue": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType" } }, "usage": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogEntryAttributes.userDataField" } }, "comparable": { "type": "string" }, "attributeValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeValueType" }, "floatValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.FloatValueType" }, "stringValue": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "displaySequence": { "type": "string", "format": "double" }, "value": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.ValueType" }, "attributeDataType": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType" } }, "parentAttributeGroup": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType" }, "extendedData": { "type": "array", "items": { "$ref": "#/components/schemas/java.util.Map-Entry" } }, "integerValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.IntegerValueType" } } }, "espot-CatalogGroup.association.catalogEntryReference": { "type": "object", "properties": { "catalogEntryIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier" }, "displayName": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "navigationPath": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-StandardPrice": { "type": "object", "properties": { "standardPriceContractID": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType" }, "standardPriceStartDate": { "type": "string" }, "standardPricePrecedence": { "type": "string", "format": "double" }, "standardPriceQualifier": { "type": "string" }, "standardUnitPrice": { "$ref": "#/components/schemas/espot-StandardUnitPrice" }, "standardPriceMaxQuantity": { "type": "string", "format": "double" }, "standardPriceEndDate": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-StandardPrice.userDataField" } }, "standardPriceLastUpdate": { "type": "string" }, "standardPriceDescription": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.DescriptionType" }, "standardPriceQuantityUnit": { "type": "string" }, "standardPriceMinQuantity": { "type": "string", "format": "double" } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.alternativeCurrencyPrice": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-ContractPrice.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier" } } }, "espot-AttachmentReferenceDescription": { "type": "object", "properties": { "attachmentName": { "type": "string" }, "attachmentLanguage": { "type": "string" }, "attachmentLongDescription": { "type": "string" }, "attachmentShortDescription": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-PropertiesContainer": { "type": "object", "properties": { "baseMarketingKey": { "type": "string", "description": "Property key." }, "baseMarketingValue": { "type": "string", "description": "Property value." } }, "description": "Structure containing optional properties related to marketing content to display." }, "espot-CatalogEntryAttributes.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-MarketingContentExternalIdentifier": { "type": "object", "properties": { "contentName": { "type": "string" }, "contentStoreExternalId": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType" }, "contentStoreId": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier.externalIdentifier" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-MarketingSpotDataTitleContainer": { "type": "object", "properties": { "contentFormatName": { "type": "string", "description": "Name of the type of the marketing content." }, "marketingContentImageMap": { "type": "array", "description": "Image map definition for the image with clickable areas.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-MarketingSpotDataTitleContainer-MarketingContentImageMapContainer" } }, "marketingSpotDataTitleId": { "type": "string", "description": "Unique ID for the marketing content." }, "MarketingContentDescription": { "type": "array", "description": "Not used.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-MarketingContentDescriptionContainer2" } }, "contentId": { "type": "string", "description": "Unique ID of the marketing content." }, "marketingSpotDataTitleDataType": { "type": "string", "description": "Type of data displayed in the marketing content." }, "marketingSpotDataTitleName": { "type": "string", "description": "Name of the marketing content." }, "marketingContentDescription": { "type": "array", "description": "Description of the marketing content.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-MarketingContentDescriptionContainer" } }, "marketingSpotDataTitleActivityID": { "type": "string", "description": "The unique identifier of the activity that returned the data to be displayed in the e-marketing spot." }, "contentClickAction": { "type": "string", "description": "Number of click actions of the marketing content. : \"None\", \"Single\"(URL) or \"Multiple\"(Image Map)." }, "contentName": { "type": "string", "description": "Name of the marketing content." }, "contentFormatId": { "type": "string", "description": "Unique ID of the type of the marketing content." }, "contentStoreId": { "type": "string", "description": "Identifier of the store associated with the marketing content." } }, "description": "Structure containing the marketing title to display in the e-marketing spot." }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData.userDataField" } } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-MarketingSpotDataTitleContainer-MarketingContentImageMapContainer-AreaTypeContainer": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the area." }, "url": { "type": "string", "description": "Click action to be invoked when the area is clicked." }, "displaySequence": { "type": "string", "description": "Sequence of the area." }, "coordinates": { "type": "string", "description": "Coordinates of the area." }, "shape": { "type": "string", "description": "Shape of the area. Three types of shape are supported: \"rect\" (Rectangle), \"circle\" (Circle) and \"poly\" (Polygon)." }, "uniqueID": { "type": "string", "description": "Unique ID of the image map area." }, "alternateText": { "type": "string", "description": "Alternate text for the area." } }, "description": "Structure containing the clickable area of an image map." }, "espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "identifier": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier" } } }, "com.ibm.commerce.rest.marketing.handler.SegmentHandler-SegmentMemberCheck": { "required": [ "isInCustomerSegment" ], "type": "object", "x-graphql-type-name": "segmentMemberCheck", "properties": { "isInCustomerSegment": { "type": "boolean", "description": "Is the specified customer in the specified segment." }, "resourceName": { "type": "string" } }, "description": "Segment membership check." }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-MarketingContentDescriptionContainer2": { "type": "object", "description": "Not used" }, "espot-MarketingSpotDataTitle": { "required": [ "marketingContent", "marketingSpotDataTitleDataType", "marketingSpotDataTitleId", "marketingSpotDataTitleName" ], "type": "object", "properties": { "experimentResult": { "type": "array", "items": { "$ref": "#/components/schemas/espot-ExperimentResult" } }, "marketingContent": { "$ref": "#/components/schemas/espot-MarketingContent" }, "marketingSpotDataTitleDataType": { "type": "string" }, "marketingSpotDataTitleName": { "type": "string" }, "marketingSpotDataTitleId": { "type": "string" }, "marketingSpotDataTitleActivityID": { "type": "string" } } }, "espot-CatalogGroup.parentCatalogGroupIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "identifier": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier" } } }, "espot-MarketingContentDescription": { "type": "object", "properties": { "marketingText": { "type": "string" }, "contentLocation": { "type": "string" }, "language": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-ExperimentResult": { "type": "object", "properties": { "controlElement": { "type": "string" }, "experiment": { "$ref": "#/components/schemas/espot-Experiment" }, "testElement": { "$ref": "#/components/schemas/espot-TestElement" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier" }, "groupIdentifier": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.externalContentReference.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier": { "required": [ "attributeDictionaryIdentifier", "identifier" ], "type": "object", "properties": { "attributeDictionaryIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier" }, "identifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData.userDataField" } } } }, "espot-CatalogGroup.navigationRelationship.catalogEntryReference": { "type": "object", "properties": { "catalogEntryIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier" }, "displayName": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "navigationPath": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo": { "type": "object", "properties": { "priority": { "type": "number", "format": "double" }, "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData" }, "mobilePriority": { "type": "number", "format": "double" }, "changeFrequency": { "type": "string" }, "mobileChangeFrequency": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price": { "type": "object", "properties": { "price": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.price" }, "quantity": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.quantity" }, "alternativeCurrencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.alternativeCurrencyPrice" } } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttributesContainer-AttributeAllowedValueContainer": { "type": "object", "properties": { "integerValue": { "type": "string", "description": "Type definition for an IntegerValue attribute." }, "floatValue": { "type": "string", "description": "Type definition for a FloatValue attribute." }, "attributeValue": { "type": "string", "description": "Abstract attribute value for customer extension." }, "stringValue": { "type": "string", "description": "Type definition for an StringValue attribute." }, "extendedValue": { "type": "array", "description": "Name-value pairs for defining additional attribute values such as images and or attachments. Can also be used for customer extension.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-NVPAttributesContainer" } } }, "description": "Structure containing the allowed values for the attribute." }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier" } } }, "espot-ContractPrice": { "type": "object", "properties": { "lastUpdate": { "type": "string" }, "endDate": { "type": "string" }, "description": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.DescriptionType" }, "precedence": { "type": "string", "format": "double" }, "quantityUnit": { "type": "string" }, "contractIdentifier": { "$ref": "#/components/schemas/espot-ContractIdentifier" }, "maximumQuantity": { "type": "string", "format": "double" }, "minimumQuantity": { "type": "string", "format": "double" }, "contractUnitPrice": { "$ref": "#/components/schemas/espot-ContractUnitPrice" }, "startDate": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-ContractPrice.userDataField" } }, "qualifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-BaseMarketingSpotActivityData.properties": { "required": [ "baseMarketingKey" ], "type": "object", "properties": { "baseMarketingKey": { "type": "string" }, "baseMarketingValue": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.quantity": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "uom": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData" }, "keyword": { "type": "string" }, "language": { "type": "string" }, "generatedMobileKeyword": { "type": "string" }, "uRLPrefix": { "type": "string" }, "mobileURLPrefix": { "type": "string" }, "previewURL": { "type": "string" }, "mobileKeyword": { "type": "string" }, "generatedKeyword": { "type": "string" }, "previewMobileURL": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.FloatValueType": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.description": { "type": "object", "properties": { "value": { "type": "string" }, "language": { "type": "string" } } }, "espot-ActivityExternalIdentifier": { "type": "object", "properties": { "activityIdentifierName": { "type": "string" }, "activityIdentifierStoreId": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference": { "required": [ "displayName" ], "type": "object", "properties": { "catalogGroupIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier" }, "displayName": { "type": "string" }, "catalogIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier" }, "navigationPath": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOURL.uRLKeyword.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-Attachment.AttachmentReferenceDescription": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-Attachment.AttachmentReferenceDescription.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage": { "required": [ "usageName" ], "type": "object", "properties": { "displaySequence": { "type": "string" }, "attachmentUsageDescription": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription" }, "image": { "type": "string" }, "usageName": { "type": "string" } } }, "espot-DefaultContentDisplaySequence": { "type": "object", "properties": { "displaySequence": { "type": "string" }, "resultId": { "type": "string" }, "resultFormat": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType": { "type": "object", "properties": { "resolved": { "type": "boolean" }, "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData" }, "language": { "type": "string" }, "metaKeyword": { "type": "string" }, "fullImageAltDescription": { "type": "string" }, "parentStoreIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier" }, "pageGroup": { "type": "string" }, "objectIdentifier": { "type": "string" }, "sEOPageDefID": { "type": "string" }, "title": { "type": "string" }, "metaDescription": { "type": "string" } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "identifier": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier" } } }, "espot-CatalogGroup.rule.element": { "type": "object", "properties": { "userData": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.rule.element.userData" } }, "type": { "type": "string" }, "uniqueID": { "type": "string" }, "nVP": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.rule.element.nVP" } } } }, "com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.parentStoreIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "espot-CatalogGroup.association.associatedObject": { "type": "object" }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier.externalIdentifier": { "required": [ "name", "origin", "ownerID" ], "type": "object", "properties": { "majorVersionNumber": { "type": "integer", "format": "int32" }, "origin": { "type": "string" }, "minorVersionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "ownerID": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier" }, "identifier": { "type": "string" } } }, "espot-CatalogGroup.facet.attribute.attributeDescription": { "type": "object", "properties": { "name": { "type": "string" }, "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.facet.attribute.attributeDescription.userData" }, "description": { "type": "string" }, "language": { "type": "string" }, "extendedData": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.facet.attribute.attributeDescription.extendedData" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "identifier": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier" }, "identifier": { "type": "string" } } }, "com.ibm.commerce.marketing.facade.datatypes.AreaType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.marketing.facade.datatypes.AreaType.userData.userDataField" } } } }, "com.ibm.commerce.marketing.facade.datatypes.AreaType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-Attachment": { "type": "object", "properties": { "attachmentReferenceId": { "type": "string" }, "attachmentIdentifier": { "$ref": "#/components/schemas/espot-AttachmentIdentifier" }, "AttachmentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-Attachment.AttachmentDescription" } }, "attachmentReferenceDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-AttachmentReferenceDescription" } }, "AttachmentReferenceDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-Attachment.AttachmentReferenceDescription" } }, "attachmentAsset": { "type": "array", "items": { "$ref": "#/components/schemas/espot-AttachmentAsset" } }, "attachmentDisplaySequence": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-Attachment.userDataField" } }, "attachmentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-AttachmentDescription" } }, "attachmentUsage": { "$ref": "#/components/schemas/espot-AttachmentUsage" } } }, "com.ibm.commerce.marketingcenter.events.runtime.ClickMonitorCommand": { "type": "object" }, "espot-Experiment": { "required": [ "experimentResultId" ], "type": "object", "properties": { "experimentResultName": { "type": "string" }, "experimentResultId": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-NVPAttributesContainer": { "type": "object", "properties": { "value": { "type": "string", "description": "Value." }, "key": { "type": "string", "description": "Key name." } }, "description": "Structure containing name-value pair attributes." }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType": { "type": "object", "properties": { "lastUpdate": { "type": "string" }, "endDate": { "type": "string" }, "description": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.description" }, "precedence": { "type": "number", "format": "double" }, "quantityUnit": { "type": "string" }, "contractIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.contractIdentifier" }, "price": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price" }, "maximumQuantity": { "type": "number", "format": "double" }, "minimumQuantity": { "type": "number", "format": "double" }, "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType.userData" }, "startDate": { "type": "string" }, "qualifier": { "type": "string" } } }, "espot-CatalogGroup.sEOURL.parentStoreIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier" } } }, "espot-CatalogGroup.sEOURL.uRLKeyword": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.uRLKeyword.userData" }, "keyword": { "type": "string" }, "language": { "type": "string" }, "generatedMobileKeyword": { "type": "string" }, "uRLPrefix": { "type": "string" }, "mobileURLPrefix": { "type": "string" }, "previewURL": { "type": "string" }, "mobileKeyword": { "type": "string" }, "generatedKeyword": { "type": "string" }, "previewMobileURL": { "type": "string" } } }, "spot-spot_item": { "type": "object", "properties": { "spotName": { "type": "string" }, "description": { "type": "string" }, "spotId": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/spot-spot_item.userDataField" } }, "type": { "type": "string" }, "uiDisplayable": { "type": "integer", "format": "int64" } } }, "espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.EventHandler-EventTrigger": { "required": [ "activityId", "baseMarketingSpotActivityID", "baseMarketingSpotDataType", "eMarketingSpotId", "experimentResultId", "experimentResultTestElementId", "personalizationID" ], "type": "object", "x-graphql-type-name": "eventTrigger", "properties": { "eMarketingSpotId": { "type": "string", "description": "Marketing spot identifier." }, "experimentResultTestElementId": { "type": "string", "description": "Experiment result test element identifier." }, "baseMarketingSpotActivityID": { "type": "string", "description": "Base marketing spot activity identifier." }, "baseMarketingSpotDataType": { "type": "string", "description": "Marketing spot data type. Example : \"MarketingContent\"." }, "categoryId": { "type": "string", "description": "Category identifier." }, "activityId": { "type": "string", "description": "Activity identifier." }, "personalizationID": { "type": "string", "description": "Personalization identifier." }, "experimentResultId": { "type": "string", "description": "Experiment result identifier." }, "searchTerm": { "type": "string", "description": "Search term. Stored in a comma-separated list of search strings." }, "DM_ReqCmd": { "type": "string", "description": "Requested command." }, "productId": { "type": "string", "description": "Product identifier." } }, "description": "Marketing event trigger. Note : all parameters specified beyond the schema are sent to the marketing event.", "example": { "eMarketingSpotId": null, "experimentResultTestElementId": null, "baseMarketingSpotActivityID": "10065", "baseMarketingSpotDataType": "MarketingContent", "categoryId": 10502, "activityId": null, "personalizationID": "1416846174646-19", "experimentResultId": null, "searchTerm": null, "DM_ReqCmd": "ProductDisplay", "productId": 12703 } }, "com.ibm.commerce.rest.marketing.handler.EventHandler-EventTrigger-clickinfo": { "type": "object", "x-graphql-type-name": "eventTriggerclickinfo", "properties": { "DM_ReqCmd": { "type": "string" }, "CategoryId": { "type": "string" }, "evtype": { "type": "string" }, "expDataType": { "type": "string" }, "expDataUniqueID": { "type": "string" }, "intv_id": { "type": "string" }, "mpe_id": { "type": "string" }, "productId": { "type": "string" } }, "required": [ "DM_ReqCmd", "CategoryId", "evtype", "expDataType", "expDataUniqueID", "intv_id", "mpe_id", "productId" ], "description": "Marketing event trigger. Note : all parameters specified beyond the schema are sent to the marketing event.", "example": { "DM_ReqCmd": "", "CategoryId": "", "evtype": "CpgnClick", "expDataType": "CatalogGroupId", "expDataUniqueID": "10516", "intv_id": "10038", "mpe_id": "10011", "productId": "" } }, "com.ibm.commerce.rest.marketing.handler.EventHandler-MarketingTrackingConsent": { "required": [ "marketingTrackingConsent" ], "type": "object", "x-graphql-type-name": "marketingTrackingConsent", "properties": { "marketingTrackingConsent": { "type": "integer", "description": "Marketing tracking consent, value can be 0 or 1." } }, "description": "Marketing tracking consent parameters.", "example": { "marketingTrackingConsent": 1 } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.ValueType": { "type": "object", "properties": { "identifier": { "type": "string" }, "value": { "type": "string" }, "storeID": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType.externalIdentifier": { "required": [ "name", "origin", "ownerID" ], "type": "object", "properties": { "majorVersionNumber": { "type": "integer", "format": "int32" }, "origin": { "type": "string" }, "minorVersionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "ownerID": { "type": "string" } } }, "espot-CatalogGroup.rule.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.rule.userData.userDataField" } } } }, "espot-CatalogGroup.rule.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference": { "required": [ "displayName" ], "type": "object", "properties": { "catalogGroupIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier" }, "displayName": { "type": "string" }, "catalogIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier" }, "navigationPath": { "type": "string" } } }, "espot-CatalogEntryIdentifier": { "type": "object", "properties": { "catalogEntryExternalIdentifier": { "$ref": "#/components/schemas/espot-CatalogEntryExternalIdentifier" }, "productId": { "type": "string" } } }, "espot-CatalogGroup.externalContentReference.externalContentAsset": { "required": [ "assetPath", "externalContentIdentifier", "name" ], "type": "object", "properties": { "mimeType": { "type": "string" }, "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.externalContentReference.externalContentAsset.userData" }, "assetPath": { "type": "string" }, "name": { "type": "string" }, "assetFullPath": { "type": "string" }, "externalContentIdentifier": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-FilteredResultContainer": { "type": "object", "properties": { "filteredResultId": { "type": "string", "description": "The unique identifier of the filtered result." }, "filteredResultFormat": { "type": "string", "description": "The format of the filtered result." } }, "description": "Structure containing the filtered result." }, "espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier": { "required": [ "partNumber" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "partNumber": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType": { "type": "object", "properties": { "catalogGroupReference": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference" }, "name": { "type": "string" }, "catalogEntryReference": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference" }, "associationCodeType": { "type": "string" }, "displaySequence": { "type": "number", "format": "double" }, "associatedObject": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.associatedObject" }, "uniqueID": { "type": "string" }, "externalSource": { "type": "boolean" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.attributes" } }, "semantic": { "type": "string" }, "quantity": { "type": "number", "format": "double" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier" } } }, "espot-CatalogGroup.facet.attribute.attributeDescription.extendedData": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier": { "required": [ "attributeDictionaryIdentifier", "identifier" ], "type": "object", "properties": { "attributeDictionaryIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier" }, "identifier": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-ListPriceContainer": { "type": "object", "properties": { "listPriceAltCurrencyPrice": { "type": "string", "description": "Unit price in other currencies." }, "listPriceCurrency": { "type": "string", "description": "Currency of the standard price." }, "listPrice": { "type": "string", "description": "The standard price." }, "listPriceQuantity": { "type": "string", "description": "Quantity of a unit." } }, "description": "Structure containing a list price." }, "espot-CatalogGroup": { "type": "object", "properties": { "catalogGroupIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroupIdentifier" }, "taxonomyAttribute": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute" }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroupDescription" } }, "externalContentReference": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.externalContentReference" } }, "owningStoreDirectory": { "type": "string" }, "topCatalogGroup": { "type": "boolean" }, "displaySequence": { "type": "number", "format": "double" }, "parentCatalogGroupIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.parentCatalogGroupIdentifier" }, "breadcrumbLocation": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.breadcrumbLocation" } }, "parentCatalogGroupId": { "type": "string" }, "rule": { "$ref": "#/components/schemas/espot-CatalogGroup.rule" }, "facet": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.facet" } }, "sEOProperties": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOProperties" } }, "attachmentReference": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference" } }, "dynamicCatalogGroup": { "type": "integer", "format": "int32" }, "navigationRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attributes" } }, "sEOURL": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL" } }, "association": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.association" } }, "navigationPath": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentReferenceDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "espot-CatalogGroup.breadcrumbLocation": { "required": [ "catalogGroupUniqueID" ], "type": "object", "properties": { "catalogGroupUniqueID": { "type": "array", "items": { "type": "string" } } } }, "espot-espot_item.filteredResult": { "type": "object", "properties": { "filteredResultId": { "type": "string" }, "filteredResultFormat": { "type": "string" } } }, "espot-CatalogGroup.rule.element.nVP": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOURL.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentReferenceIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "espot-CatalogGroup.sEOURL.parentStoreIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.parentStoreIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-CatalogGroupExternalIdentifier": { "required": [ "categoryGroupId", "categoryIdentifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "categoryIdentifier": { "type": "string" }, "categoryGroupId": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.rule.element.userData": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier": { "required": [ "partNumber" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "partNumber": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier" } } }, "espot-StandardUnitPrice": { "type": "object", "properties": { "standardPriceQuantity": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.QuantityType" }, "standardPrice": { "type": "string", "format": "double" }, "standardPriceAltCurrencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType" } }, "standardPriceCurrency": { "type": "string" } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier" }, "groupIdentifier": { "type": "string" } } }, "espot-CatalogGroup.sEOProperties.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOProperties.userData.userDataField" } } } }, "espot-CatalogGroup.rule": { "type": "object", "properties": { "userData": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.rule.userData" } }, "nVP": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.rule.nVP" } }, "uniqueID": { "type": "string" }, "element": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.rule.element" } } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-MarketingContentDescriptionContainer": { "type": "object", "properties": { "marketingText": { "type": "string", "description": "Marketing text of a marketing content." }, "contentLocation": { "type": "string", "description": "Location of a marketing content." }, "language": { "type": "string", "description": "Supported languages of a marketing content." } }, "description": "Structure containing marketing content description." }, "segment-segments_item": { "type": "object", "properties": { "usage": { "type": "array", "items": { "type": "string" } }, "displayName": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.DescriptionType" }, "description": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.DescriptionType" }, "id": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.externalContentReference.externalContentAsset.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.externalContentReference.externalContentAsset.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "attributeDictionaryIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.storeIdentifier" }, "identifier": { "type": "string" } } }, "espot-Attachment.AttachmentDescription": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-Attachment.AttachmentDescription.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData.userDataField" } } } }, "espot-ListPrice": { "type": "object", "properties": { "listPriceAltCurrencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType" } }, "listPriceCurrency": { "type": "string" }, "listPrice": { "type": "string", "format": "double" }, "listPriceQuantity": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.QuantityType" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier" } } }, "espot-CatalogGroupIdentifier": { "type": "object", "properties": { "catalogGroupExternalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroupExternalIdentifier" }, "categoryId": { "type": "string" } } }, "espot-StandardPrice.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "Empty": { "type": "object", "description": "Empty model. Used as default value when no model is specified." }, "com.ibm.commerce.marketing.facade.datatypes.AreaType": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.marketing.facade.datatypes.AreaType.userData" }, "target": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "displaySequence": { "type": "number", "format": "double" }, "coordinates": { "type": "string" }, "shape": { "type": "string", "enum": [ "rect", "circle", "poly" ] }, "uniqueID": { "type": "string" }, "alternateText": { "type": "string" } } }, "espot-CatalogGroup.association": { "type": "object", "properties": { "catalogGroupReference": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference" }, "name": { "type": "string" }, "catalogEntryReference": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogEntryReference" }, "associationCodeType": { "type": "string" }, "displaySequence": { "type": "number", "format": "double" }, "associatedObject": { "$ref": "#/components/schemas/espot-CatalogGroup.association.associatedObject" }, "uniqueID": { "type": "string" }, "externalSource": { "type": "boolean" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.association.attributes" } }, "semantic": { "type": "string" }, "quantity": { "type": "number", "format": "double" } } }, "espot-MarketingSpotIdentifier": { "type": "object", "properties": { "marketingSpotExternalIdentifier": { "$ref": "#/components/schemas/espot-MarketingSpotExternalIdentifier" }, "marketingSpotIdentifier": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.facet.facetIdentifier": { "type": "object", "properties": { "identifier": { "type": "string" }, "uniqueID": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference": { "type": "object", "properties": { "catalogEntryIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier" }, "displayName": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "navigationPath": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer": { "type": "object", "properties": { "attachmentReferenceId": { "type": "string", "description": "Unique identifier for the attachment reference." }, "attachmentUsageName": { "type": "string", "description": "Name of the attachment usage." }, "standardPriceQuantity": { "type": "string", "description": "Quantity of a unit." }, "standardPriceCurrency": { "type": "string", "description": "Currency of the standard price." }, "standardPricePrecedence": { "type": "string", "description": "Precedence of contract." }, "contentName": { "type": "string", "description": "Name of the marketing content." }, "standardPriceAltCurrencyPrice": { "type": "string", "description": "Unit price in other currencies." }, "contentFormatName": { "type": "string", "description": "Name of the type of the marketing content." }, "standardPriceQualifier": { "type": "string", "description": "A uniquely identifying number that identifies the standard price." }, "standardPrice": { "type": "string", "description": "The standard price." }, "standardPriceMinQuantity": { "type": "string", "description": "Minimum quantity." }, "attachementOwnerId": { "type": "string", "description": "Owner of the attachment target." }, "standardPriceStartDate": { "type": "string", "description": "Start date." }, "standardPriceQuantityUnit": { "type": "string", "description": "Unit of measure for minimumQuantity and maximumQuantity." }, "xcatg_displayTemplate": { "type": "string", "description": "The display template for the catalog group." }, "topCatalogGroup": { "type": "string", "description": "Attribute indicating whether catalog group is a top-level catalog group." }, "standardPriceLastUpdate": { "type": "string", "description": "Date of last update." }, "attachmentDescription": { "type": "array", "description": "Description of an attachment.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer" } }, "attachementExternalId": { "type": "string", "description": "External identifying name for the attachment target." }, "storeIdentifier": { "type": "string", "description": "External store identifier for the catalog entry/catalog group." }, "MarketingContentDescription": { "type": "array", "description": "Not used.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-MarketingContentDescriptionContainer2" } }, "navigationRelationship": { "type": "string", "description": "Type definition for a navigational relationship" }, "listPrice": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-ListPriceContainer" }, "standardPriceDescription": { "type": "string", "description": "Description of the standard price." }, "contentInputOption": { "type": "string", "description": "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": { "type": "array", "description": "Description of the marketing content.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-MarketingContentDescriptionContainer" } }, "AttachmentReferenceDescription": { "type": "array", "description": "Not used", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer2" } }, "contentClickAction": { "type": "string", "description": "Number of click actions of the marketing content. : \"None\", \"Single\"(URL) or \"Multiple\"(Image Map)." }, "attachmentImage": { "type": "string", "description": "Image path of the attachment relation usage." }, "catalogEntryTypeCode": { "type": "string", "description": "Catalog entry type code." }, "categoryId": { "type": "string", "description": "Unique identifier for the category." }, "attachmentAsset": { "type": "array", "description": "Definition of an attachment asset.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttachmentAssetContainer" } }, "productId": { "type": "string", "description": "Unique ID of the product." }, "contentUrl": { "type": "string", "description": "Click action to be invoked when marketing content on the page is clicked." }, "standardPriceContractID": { "type": "string", "description": "Contract identifier the standard price is associated with." }, "baseMarketingSpotActivityID": { "type": "string", "description": "Unique identifier for the data displayed in the e-marketing spot." }, "categoryIdentifier": { "type": "string", "description": "Catalog group identifier." }, "attachmentUsageDescription": { "type": "array", "description": "Language or locale specific description of an attachment.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer" } }, "description": { "type": "array", "description": "Description of the catalog entry/category.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-DescriptionContainer" } }, "attachementStoreExternalId": { "type": "string", "description": "External identifier of the store that owns the attachment." }, "contentMimeType": { "type": "string", "description": "MIME type of the marketing content." }, "activityPriority": { "type": "string", "description": "Priority of the activity that returned the\tdata to be displayed in the e-marketing spot." }, "activityIdentifierID": { "type": "string", "description": "Unique identifier for the activity." }, "attachementId": { "type": "string", "description": "Identifier for the attachment" }, "parentCatalogGroupId": { "type": "string", "description": "Parent catalog group identifier. Null for top-level catalog groups." }, "sEOURL": { "type": "string", "description": "SEO URL associated with the catalog entry / catalog group." }, "attachmentReferenceDescription": { "type": "array", "description": "Description of the relationship between the business object and the attachment.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer" } }, "xcatg_rootDirectory": { "type": "string", "description": "The root directory for the catalog group." }, "ownerId": { "type": "string", "description": "Owner organization of the catalog entry/catalog group." }, "taxonomyAttribute": { "type": "string", "description": "Taxonomy attributes for the catalog group." }, "attachmentDisplaySequence": { "type": "string", "description": "Sequence of the attachment relation usage." }, "contentFormatId": { "type": "string", "description": "Unique ID of the type of the marketing content." }, "baseMarketingSpotCampaignName": { "type": "string", "description": "Name of the campaign that returned the data to be displayed in the e-marketing spot" }, "properties": { "type": "array", "description": "Properties related to marketing content.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-PropertiesContainer" } }, "association": { "type": "string", "description": "Association to other objects." }, "contentStoreId": { "type": "string", "description": "Identifier of the store associated with the marketing content." }, "activityFormat": { "type": "string", "description": "Type of the activity that returned the data to be displayed in the e-marketing spot." }, "baseMarketingSpotDataType": { "type": "string", "description": "Type of the data displayed in the e-marketing spot." }, "sEOProperties": { "type": "string", "description": "SEO properties associated with the catalog entry / catalog group." }, "standardPriceEndDate": { "type": "string", "description": "End date." }, "contentId": { "type": "string", "description": "Unique ID of the marketing content." }, "displaySequence": { "type": "string", "description": "Sequence of display of catalog entry." }, "activityIdentifierName": { "type": "string", "description": "Name of the activity." }, "attachementStoreId": { "type": "string", "description": "Identifier of the store that owns the attachment." }, "standardPriceMaxQuantity": { "type": "string", "description": "Maximum quantity." }, "productPartNumber": { "type": "string", "description": "Part number or SKU for the product." }, "AttachmentDescription": { "type": "array", "description": "Not used", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer2" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttributesContainer" } }, "baseMarketingSpotActivityName": { "type": "string", "description": "Name of the data displayed in the e-marketing spot." }, "categoryGroupId": { "type": "string", "description": "Catalog group identifier." }, "contentStoreExternalId": { "type": "string", "description": "Unique external identifier of the store associated with the marketing content." }, "contractPrice": { "type": "array", "description": "The contract price object.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-ContractPriceContainer" } } }, "description": "The data to display in the e-marketing spot. This contains the data and the information about the activity that returned this data." }, "espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "espot-MarketingContentIdentifier": { "type": "object", "properties": { "contentId": { "type": "string" }, "marketingContentExternalIdentifier": { "$ref": "#/components/schemas/espot-MarketingContentExternalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType": { "required": [ "value" ], "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData" }, "storeID": { "type": "string" }, "attributeValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.attributeValue" }, "language": { "type": "string" }, "default": { "type": "boolean" }, "displaySequence": { "type": "number", "format": "double" }, "floatValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.floatValue" }, "value": { "type": "string" }, "extendedValue": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.extendedValue" } }, "stringValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.stringValue" }, "identifier": { "type": "string" }, "integerValue": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.integerValue" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData.userDataField" } } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-SearchTermsContainer": { "required": [ "searchTerms" ], "type": "object", "x-graphql-type-name": "ESpotDataSearchContainer", "properties": { "resourceId": { "type": "string" }, "searchTerms": { "type": "string", "description": "Encoded list of all the search terms." }, "resourceName": { "type": "string" } }, "description": "Structure containing multiple search terms." }, "com.ibm.commerce.catalog.facade.datatypes.IntegerValueType": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData.userDataField" } } } }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.sEOURL.siteMapInfo.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttachmentAssetContainer": { "type": "object", "properties": { "attachmentAssetLanguage": { "type": "array", "description": "Language ID for the language-specific fields in this input file.", "items": { "type": "string" } }, "attachmentLocalAsset": { "type": "string", "description": "Attribute to indicate whether this attachment is a local attachment." }, "attachmentAssetMimeType": { "type": "string", "description": "MIME type of the attachment asset." }, "attachmentAssetRootDirectory": { "type": "string", "description": "Root directory for the attachment asset." }, "attachmentAssetDirectoryPath": { "type": "string", "description": "Directory path to the attachment asset." }, "attachmentAssetId": { "type": "string", "description": "Identifier of the attachment asset." }, "attachmentAssetStoreExternalId": { "type": "string", "description": "External identifier of the store that owns the attachment asset." }, "attachmentAssetStoreId": { "type": "string", "description": "Identifier of the store that owns the attachment asset." }, "attachmentAssetPath": { "type": "string", "description": "Relative path of the attachment asset." } }, "description": "Structure containing the attachment asset." }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogIdentifier.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.attributeValue": { "type": "object" }, "espot-CatalogGroup.attachmentReference.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.userData.userDataField" } } } }, "espot-CatalogGroup.attachmentReference.attachmentAsset.attachmentAssetIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.attachmentReference": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.userData" }, "attachmentIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentIdentifier" }, "attachmentReferenceIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentReferenceIdentifier" }, "displaySequence": { "type": "string" }, "attachmentReferenceDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentReferenceDescription" } }, "attachmentAsset": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentAsset" } }, "attachmentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentDescription" } }, "attachmentUsage": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentUsage" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.ContractIdentifierType.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData.userDataField" } } } }, "espot-AttachmentUsage": { "required": [ "attachmentUsageName" ], "type": "object", "properties": { "attachmentDisplaySequence": { "type": "string" }, "attachmentUsageName": { "type": "string" }, "attachmentUsageDescription": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType" }, "attachmentImage": { "type": "string" } } }, "espot-MarketingContent.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.DescriptionType": { "type": "object", "properties": { "value": { "type": "string" }, "language": { "type": "string" } } }, "espot-ContractExternalIdentifier": { "required": [ "name", "origin", "ownerID" ], "type": "object", "properties": { "majorVersionNumber": { "type": "string", "format": "int32" }, "origin": { "type": "string" }, "minorVersionNumber": { "type": "string", "format": "int32" }, "name": { "type": "string" }, "ownerID": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentDescription.userData.userDataField" } } } }, "espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-MarketingSpotExternalIdentifier": { "type": "object", "properties": { "eSpotStoreId": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType" }, "eSpotName": { "type": "string" } } }, "spot-spot": { "type": "object", "properties": { "resourceId": { "type": "string" }, "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "boolean" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "MarketingSpot": { "type": "array", "items": { "$ref": "#/components/schemas/spot-spot_item" } }, "recordSetTotal": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeValueType": { "type": "object" }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType": { "required": [ "catalogEntryReference" ], "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType.attributes" } }, "displaySequence": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "kitComponentCodeType": { "type": "string" }, "catalogEntryReference": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference": { "type": "object", "properties": { "catalogEntryIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogEntryReference.catalogEntryIdentifier" }, "displayName": { "type": "string" }, "catalogEntryTypeCode": { "type": "string" }, "navigationPath": { "type": "string" } } }, "espot-CatalogGroup.association.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOURL.siteMapInfo.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.siteMapInfo.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-espot_item": { "type": "object", "properties": { "nextTimeLimit": { "type": "string", "format": "int64" }, "marketingSpotIdentifier": { "$ref": "#/components/schemas/espot-MarketingSpotIdentifier" }, "baseMarketingSpotActivityData": { "type": "array", "items": { "$ref": "#/components/schemas/espot-BaseMarketingSpotActivityData" } }, "filteredResult": { "type": "array", "items": { "$ref": "#/components/schemas/espot-espot_item.filteredResult" } }, "defaultContentDisplaySequence": { "type": "array", "items": { "$ref": "#/components/schemas/espot-DefaultContentDisplaySequence" } }, "marketingSpotDataTitle": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingSpotDataTitle" } }, "behavior": { "type": "string" }, "previewReport": { "type": "array", "items": { "type": "string" } } } }, "espot-CatalogGroup.externalContentReference.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.externalContentReference.userData.userDataField" } } } }, "espot-Attachment.AttachmentDescription.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer2": { "type": "object", "description": "Not used" }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.floatValue": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier" }, "groupIdentifier": { "type": "string" } } }, "espot-AttachmentAsset": { "required": [ "attachmentAssetPath" ], "type": "object", "properties": { "attachmentAssetLanguage": { "type": "array", "items": { "type": "string" } }, "attachmentLocalAsset": { "type": "string" }, "attachmentAssetMimeType": { "type": "string" }, "attachmentAssetRootDirectory": { "type": "string" }, "attachmentAssetDirectoryPath": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-AttachmentAsset.userDataField" } }, "attachmentAssetId": { "type": "string" }, "attachmentAssetStoreExternalId": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType" }, "attachmentAssetStoreId": { "type": "string" }, "attachmentAssetPath": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-ContractPriceContainer": { "type": "object", "properties": { "majorVersionNumber": { "type": "string", "description": "Major version." }, "lastUpdate": { "type": "string", "description": "Date of last update." }, "endDate": { "type": "string", "description": "End date." }, "description": { "type": "string", "description": "Description of the offer price." }, "precedence": { "type": "string", "description": "Precedence of contract." }, "quantityUnit": { "type": "string", "description": "Unit of measure for minimumQuantity and maximumQuantity." }, "minorVersionNumber": { "type": "string", "description": "Minor version." }, "startDate": { "type": "string", "description": "Start date." }, "qualifier": { "type": "string", "description": "A uniquely identifying number that identifies the contract price." }, "name": { "type": "string", "description": "Contact name." }, "currency": { "type": "string", "description": "Currency of the offer price." }, "maximumQuantity": { "type": "string", "description": "Maximum quantity." }, "minimumQuantity": { "type": "string", "description": "Minimum quantity." }, "alternativeCurrencyPrice": { "type": "string", "description": "Unit price in other currencies." }, "ownerID": { "type": "string", "description": "Owner of the contract." }, "quantity": { "type": "string", "description": "Quantity of a unit." }, "contractPrice": { "type": "string", "description": "The contract price." }, "origin": { "type": "string", "description": "Origin of the contract." }, "contractID": { "type": "string", "description": "Contract identifier the offer price is associated with." } }, "description": "Structure containing an contract price." }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.CatalogEntryNavigationRelationshipType": { "type": "object" }, "espot-CatalogEntry.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-MarketingContent.MarketingContentDescription": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingContent.MarketingContentDescription.userDataField" } } } }, "espot-Attachment.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription.userData.userDataField" } } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer": { "required": [ "MarketingSpotData" ], "type": "object", "x-graphql-type-name": "ESpotDataContainer", "properties": { "resourceId": { "type": "string" }, "MarketingSpotData": { "type": "array", "description": "Data to display in the e-marketing spot.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer" } }, "resourceName": { "type": "string" } }, "description": "Structure containing an e-marketing spot." }, "espot-CatalogGroup.attachmentReference.attachmentReferenceDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOProperties.parentStoreIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier.externalIdentifier" } } }, "espot-CatalogGroupDescription": { "type": "object", "properties": { "categoryName": { "type": "string" }, "language": { "type": "string" }, "fullImage": { "type": "string" }, "longDescription": { "type": "string" }, "keyword": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/java.util.Map-Entry" } }, "shortDescription": { "type": "string" }, "thumbnail": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeGroupIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier" } } }, "spot-spot_item.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.attachmentReference.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-BaseMarketingSpotActivityData": { "required": [ "baseMarketingSpotActivityID", "baseMarketingSpotActivityName", "baseMarketingSpotDataType", "catalogEntry", "catalogGroup", "marketingContent" ], "type": "object", "properties": { "activityFormat": { "type": "string" }, "activityIdentifier": { "$ref": "#/components/schemas/espot-ActivityIdentifier" }, "baseMarketingSpotActivityID": { "type": "string" }, "baseMarketingSpotDataType": { "type": "string" }, "experimentResult": { "type": "array", "items": { "$ref": "#/components/schemas/espot-ExperimentResult" } }, "marketingContent": { "$ref": "#/components/schemas/espot-MarketingContent" }, "activityPriority": { "type": "string", "format": "int64" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-BaseMarketingSpotActivityData.userDataField" } }, "baseMarketingSpotActivityName": { "type": "string" }, "baseMarketingSpotCampaignName": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/espot-BaseMarketingSpotActivityData.properties" } }, "catalogGroup": { "$ref": "#/components/schemas/espot-CatalogGroup" }, "catalogEntry": { "$ref": "#/components/schemas/espot-CatalogEntry" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-AttachmentDescriptionContainer": { "type": "object", "properties": { "attachmentName": { "type": "string", "description": "Language-dependent name of the attachment." }, "attachmentLanguage": { "type": "string", "description": "Supported languages of an attachment asset." }, "attachmentLongDescription": { "type": "string", "description": "Long description of the attachment." }, "attachmentShortDescription": { "type": "string", "description": "Short description of the attachment." } }, "description": "Structure containing attachment description." }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-DescriptionContainer": { "type": "object", "properties": { "categoryName": { "type": "string", "description": "Name of the category." }, "language": { "type": "string", "description": "Language type." }, "fullImage": { "type": "string", "description": "Full image of the catalog entity." }, "longDescription": { "type": "string", "description": "Long description of the catalog entity." }, "keyword": { "type": "string", "description": "Search keywords for the catalog entity." }, "attributes": { "type": "array", "description": "Set of name-value pair attributes.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-NVPAttributesContainer" } }, "productName": { "type": "string", "description": "Name of the catalog entry." }, "shortDescription": { "type": "string", "description": "Short description of the catalog entity." } }, "description": "Structure containing the catalog entry/category description." }, "java.util.Map-Entry": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOProperties.parentStoreIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOProperties.parentStoreIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage.attachmentUsageDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttributesContainer": { "type": "object", "properties": { "comparable": { "type": "string", "description": "If attribute can be used for comparison." }, "floatValue": { "type": "string", "description": "Type definition for a FloatValue attribute." }, "extendedValue": { "type": "array", "description": "Name-value pairs for defining additional attribute values such as images and or attachments. Can also be used for customer extension.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-NVPAttributesContainer" } }, "attributeValue": { "type": "string", "description": "Abstract attribute value for customer extension." }, "language": { "type": "string", "description": "Optional language for the attribute." }, "groupPath": { "type": "string", "description": "Group path of the attribute, listing all ancestor groups of this attribute." }, "displaySequence": { "type": "string", "description": "Display sequence of a displayable attribute." }, "extendedData": { "type": "array", "description": "Extended data.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-NVPAttributesContainer" } }, "attributeIdentifier": { "type": "string", "description": "If the attribute is a reference to an attribute from the attribute dictionary." }, "displayable": { "type": "string", "description": "If attribute is displayable in storefront." }, "attributeDataType": { "type": "string", "description": "Attribute data type." }, "values": { "type": "array", "description": "All values for the attribute", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttributesContainer-AttributeAllowedValueContainer" } }, "attributeType": { "type": "string", "description": "Attribute type" }, "allowedValue": { "type": "array", "description": "Allowed values for the attribute.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer-AttributesContainer-AttributeAllowedValueContainer" } }, "usage": { "type": "string", "description": "Use for the attribute." }, "stringValue": { "type": "string", "description": "Type definition for an StringValue attribute." }, "searchable": { "type": "string", "description": "If attribute can be used for search." }, "parentAttributeGroup": { "type": "string", "description": "Parent attribute group for this attribute." }, "name": { "type": "string", "description": "Attribute name." }, "integerValue": { "type": "string", "description": "Type definition for an IntegerValue attribute." }, "description": { "type": "string", "description": "Attribute description." } }, "description": "Structure containing attributes." }, "espot-BaseMarketingSpotActivityData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "identifier": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogIdentifier.externalIdentifier.storeIdentifier" } } }, "espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.facet.attribute.attributeDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOURLType": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.userData" }, "parentStoreIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.parentStoreIdentifier" }, "tokenValue": { "type": "string" }, "uRLKeywordID": { "type": "string" }, "uRLKeyword": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.uRLKeyword" } }, "usage": { "type": "string" }, "siteMapInfo": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType.siteMapInfo" } } }, "espot-CatalogGroup.sEOURL.uRLKeyword.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.uRLKeyword.userData.userDataField" } } } }, "espot-CatalogEntry": { "type": "object", "properties": { "catalogEntryIdentifier": { "$ref": "#/components/schemas/espot-CatalogEntryIdentifier" }, "standardPrice": { "$ref": "#/components/schemas/espot-StandardPrice" }, "description": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogEntryDescription" } }, "navigationRelationship": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.CatalogEntryNavigationRelationshipType" } }, "contractPrice": { "type": "array", "items": { "$ref": "#/components/schemas/espot-ContractPrice" } }, "displaySequence": { "type": "string", "format": "double" }, "parentCatalogGroupIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType" }, "kitComponent": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType" } }, "sEOURL": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOURLType" } }, "listPrice": { "$ref": "#/components/schemas/espot-ListPrice" }, "sEOProperties": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType" } }, "attachmentReference": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType" } }, "floorPrice": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.OfferPriceType" }, "fulfillmentProperties": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.CatalogEntryFulfillmentPropertiesType" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogEntryAttributes" } }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogEntry.userDataField" } }, "catalogEntryTypeCode": { "type": "string" }, "association": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.AssociationType" } }, "navigationPath": { "type": "string" } } }, "espot-CatalogGroup.parentCatalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.attachmentReference.attachmentAsset.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentAsset.userData.userDataField" } } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-AttachmentExternalIdentifier": { "required": [ "attachementExternalId" ], "type": "object", "properties": { "attachementOwnerId": { "type": "string" }, "attachementStoreId": { "type": "string" }, "attachementStoreExternalId": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType" }, "attachementExternalId": { "type": "string" } } }, "espot-CatalogGroup.association.catalogGroupReference": { "required": [ "displayName" ], "type": "object", "properties": { "catalogGroupIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogGroupIdentifier" }, "displayName": { "type": "string" }, "catalogIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogGroupReference.catalogIdentifier" }, "navigationPath": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "espot-AttachmentDescription": { "type": "object", "properties": { "attachmentName": { "type": "string" }, "attachmentLanguage": { "type": "string" }, "attachmentLongDescription": { "type": "string" }, "attachmentShortDescription": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.associatedObject": { "type": "object" }, "com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttributeIdentifierType.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-AttachmentAsset.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-ContractUnitPrice": { "type": "object", "properties": { "currency": { "type": "string" }, "quantity": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.QuantityType" }, "contractPrice": { "type": "string", "format": "double" }, "alternativeCurrencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType" } } } }, "espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData.userDataField" } } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset": { "required": [ "attachmentAssetPath" ], "type": "object", "properties": { "mimeType": { "type": "string" }, "attachmentAssetIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.attachmentAssetIdentifier" }, "rootDirectory": { "type": "string" }, "language": { "type": "array", "items": { "type": "string" } }, "directoryPath": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.storeIdentifier" }, "localAsset": { "type": "boolean" }, "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.userData" }, "attachmentAssetPath": { "type": "string" } } }, "espot-MarketingContentImageMap.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.sEOURL": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.userData" }, "parentStoreIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.parentStoreIdentifier" }, "tokenValue": { "type": "string" }, "uRLKeywordID": { "type": "string" }, "uRLKeyword": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.uRLKeyword" } }, "usage": { "type": "string" }, "siteMapInfo": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.siteMapInfo" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.integerValue": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "espot-CatalogGroup.sEOURL.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.sEOURL.userData.userDataField" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.userData" }, "attachmentIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier" }, "attachmentReferenceIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceIdentifier" }, "displaySequence": { "type": "string" }, "attachmentReferenceDescription": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription" } }, "attachmentAsset": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset" } }, "attachmentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentDescription" } }, "attachmentUsage": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentUsage" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentReferenceDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.CatalogGroupIdentifierType.externalIdentifier" } } }, "segment-segments": { "type": "object", "properties": { "resourceId": { "type": "string" }, "recordSetCount": { "type": "integer", "format": "int32" }, "recordSetComplete": { "type": "boolean" }, "recordSetStartNumber": { "type": "integer", "format": "int32" }, "resourceName": { "type": "string" }, "MemberGroup": { "type": "array", "items": { "$ref": "#/components/schemas/segment-segments_item" } }, "recordSetTotal": { "type": "integer", "format": "int32" } } }, "espot-CatalogGroup.navigationRelationship": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.attributes" } }, "displaySequence": { "type": "number", "format": "double" }, "catalogGroupReference": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference" }, "type": { "type": "string" }, "catalogEntryReference": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogEntryReference" } } }, "espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.navigationRelationship.catalogGroupReference.catalogGroupIdentifier.externalIdentifier" } } }, "espot-CatalogGroup.externalContentReference.externalContentAsset.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.taxonomyAttribute.attribute.externalIdentifier.attributeDictionaryIdentifier.externalIdentifier" } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.stringValue": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" } } }, "espot-CatalogEntryExternalIdentifier": { "required": [ "productPartNumber" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "productPartNumber": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType" } } }, "espot-CatalogGroup.attachmentReference.attachmentAsset.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.catalog.facade.datatypes.AssociationType.catalogGroupReference.catalogGroupIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "espot-espot": { "type": "object", "properties": { "resourceId": { "type": "string" }, "MarketingSpotData": { "type": "array", "items": { "$ref": "#/components/schemas/espot-espot_item" } }, "resourceName": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-DefaultContentDisplaySequenceContainer": { "type": "object", "properties": { "displaySequence": { "type": "string", "description": "Sequence value of the default content." }, "resultId": { "type": "string", "description": "Unique identifier of the result." }, "resultFormat": { "type": "string", "description": "Type of the result. Valid values include MarketingContent, CatalogGroup, CatalogEntry." } }, "description": "Structure containing the default content sequence values." }, "espot-AttachmentIdentifier": { "type": "object", "properties": { "attachementId": { "type": "string" }, "attachmentExternalIdentifier": { "$ref": "#/components/schemas/espot-AttachmentExternalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.OfferPriceType.price.price": { "type": "object", "properties": { "currency": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "espot-CatalogGroup.attachmentReference.attachmentUsage": { "required": [ "usageName" ], "type": "object", "properties": { "displaySequence": { "type": "string" }, "attachmentUsageDescription": { "$ref": "#/components/schemas/espot-CatalogGroup.attachmentReference.attachmentUsage.attachmentUsageDescription" }, "image": { "type": "string" }, "usageName": { "type": "string" } } }, "espot-ContractIdentifier": { "type": "object", "properties": { "contractExternalIdentifier": { "$ref": "#/components/schemas/espot-ContractExternalIdentifier" }, "contractID": { "type": "string" } } }, "com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer": { "required": [ "marketingSpotIdentifier" ], "type": "object", "properties": { "eSpotStoreId": { "type": "string", "description": "The store identifier." }, "nextTimeLimit": { "type": "string", "description": "The number of seconds from now to the earliest start date or end date of activities scheduled to the e-Marketing Spot." }, "marketingSpotIdentifier": { "type": "string", "description": "The unique identifier of the e-marketing spot." }, "baseMarketingSpotActivityData": { "type": "array", "description": "Base e-marketing spot activity data.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-BaseMarketingSpotActivityDataContainer" } }, "filteredResult": { "type": "array", "description": "Result that was filtered from display in the e-Marketing Spot.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-FilteredResultContainer" } }, "defaultContentDisplaySequence": { "type": "array", "description": "Sequence values of the default content to display in the e-marketing spot.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-DefaultContentDisplaySequenceContainer" } }, "marketingSpotDataTitle": { "type": "array", "description": "Marketing title to display in the e-marketing spot.", "items": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.ESpotDataHandler-ESpotContainer-MarketingSpotDataContainer-MarketingSpotDataTitleContainer" } }, "eSpotName": { "type": "string", "description": "The e-marketing Spot name." }, "behavior": { "type": "string", "description": "The current caching behavior of the e-marketing spot." }, "previewReport": { "type": "array", "description": "Information about the activity evaluation.", "items": { "type": "string" } } }, "description": "Data to display in the e-marketing spot." }, "espot-CatalogGroup.facet.attribute": { "required": [ "attributeDescription" ], "type": "object", "properties": { "attributeDescription": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.facet.attribute.attributeDescription" } } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "com.ibm.commerce.foundation.common.datatypes.AttachmentReferenceType.attachmentAsset.attachmentAssetIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.QuantityType": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "uom": { "type": "string" } } }, "espot-CatalogGroup.externalContentReference": { "required": [ "externalContentIdentifier", "name" ], "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/espot-CatalogGroup.externalContentReference.userData" }, "externalContentDescription": { "type": "string" }, "language": { "type": "string" }, "lastUpdateTime": { "type": "string" }, "externalContentAsset": { "type": "array", "items": { "$ref": "#/components/schemas/espot-CatalogGroup.externalContentReference.externalContentAsset" } }, "uniqueID": { "type": "string" }, "externalContentIdentifier": { "type": "string" }, "externalContentType": { "type": "string" }, "name": { "type": "string" } } }, "com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType.userData.userDataField" } } } }, "com.ibm.commerce.catalog.facade.datatypes.AttributeAllowedValueType.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/espot-CatalogGroup.association.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "espot-MarketingContentImageMap": { "type": "object", "properties": { "source": { "type": "string" }, "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/espot-MarketingContentImageMap.userDataField" } }, "name": { "type": "string" }, "area": { "type": "array", "items": { "$ref": "#/components/schemas/com.ibm.commerce.marketing.facade.datatypes.AreaType" } } } }, "com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier": { "required": [ "partNumber" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "partNumber": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/com.ibm.commerce.catalog.facade.datatypes.KitComponentType.catalogEntryReference.catalogEntryIdentifier.externalIdentifier.storeIdentifier" } } }, "com.ibm.commerce.marketing.beans.UserBehaviorListDataBean_IBM_Admin_Summary": { "type": "object", "x-graphql-type-name": "userBehaviorListAdminSummary", "properties": { "behaviorList": { "type": "array", "description": "List of marketing tracking data for the storefront user", "items": { "$ref": "#/components/schemas/com.ibm.commerce.marketing.beans.UserBehaviorListDataBean_IBM_Admin_Summary.behaviorList" } } } }, "com.ibm.commerce.marketing.beans.UserBehaviorListDataBean_IBM_Admin_Summary.behaviorList": { "type": "object", "properties": { "data": { "type": "string", "description": "The data value" }, "time": { "type": "string", "description": "The time which the behavior was recorded" }, "elementTemplateName": { "type": "string", "description": "The name of the marketing element template" } }, "description": "" }, "com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse": { "type": "object", "x-graphql-type-name": "deleteUserBehaviorResponse", "properties": { "response": { "$ref": "#/components/schemas/com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse.message" } } }, "com.ibm.commerce.rest.marketing.handler.UserBehaviorHandler-DeleteUserBehaviorResponse.message": { "type": "object", "properties": { "message": { "type": "string", "description": "The response message" } } }, "behavior_rules-behavior_rules": { "type": "object", "properties": { "resourceName": { "type": "string", "description": "The resourceName" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "x-aes-documentation": { "gettingstarted": [ { "content": "HCL Commerce REST services support JSON and XML formats for input and output data by default. The default format is JSON. When an XML String is sent to a REST service, you must set Content-Type HTTP header to be \"application/xml\". The REST service converts the XML input data to the JSON format that is accepted by REST services. Therefore, your input XML format must follow a certain structure so that it can be transformed to the JSON object that is accepted by REST services. See more here: ", "codeSnippets": [], "name": "Response formats" }, { "content": "Preview tokens are encrypted strings that encapsulates a set of preview options and restrictions on when and where the token can be used. Any user who is authorized to access your server and has a preview token, can complete preview actions in the same store for which that token is generated. See more here: ", "codeSnippets": [], "name": "Preview tokens" }, { "content": "Some HCL Commerce REST services require a request to be sent over HTTPS. Learn more here: ", "codeSnippets": [], "name": "Secure Sockets Layer" } ] } }