openapi: 3.0.1 info: title: Recommendation description: | The Recommendation REST API contains operations that allow to improve the online shopping experience by offering personalized product suggestions to customers. Recommendations are based on user behavior and product relationships, and they can be used in various contexts within your online shop. Using this REST API requires a configured recommendation engine. For more details, see [Overview - Recommendation](https://support.intershop.com/kb/index.php/Display/2Y7872) in the Intershop Knowledge Base. ## Changelog - - - ### Version 1.1.0 * Added this changelog * Corrected wrong status codes * Minor documentation changes (recommendationcontexts, events) contact: name: Intershop Communications AG url: http://intershop.com version: 1.1.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - rest - rest - example - "-" default: rest paths: /recommendationcontexts: post: tags: - Recommendation summary: Creates a new recommendation context description: | This operation creates a new recommendation context. A recommendation context is just a simple string that is used as a replacement for the session ID. All events that are created for a recommendation context via REST are tagged with this context ID when they are transmitted to the connected recommendation engine. It has no semantic meaning to the recommendation engine, it just symbolizes that events with the same ID belong to the same session. This is necessary to ensure a valid data basis. operationId: createContext responses: "201": description: Created content: '*/*': schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource.createContext() x-origin-class: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource /recommendationcontexts/{RecommendationContextKey}/basketrecommendations: get: tags: - Recommendation Request summary: Returns recommended products for the given basket description: "This operation returns a list of recommended products for the\ \ given basket based on the basketID. This requires a configured recommendation\ \ service. The resulting list strongly depends on the configuration of the\ \ recommendation engine and on the back office preferences of the channel\ \ (Preferences | Recommendation Engines). If the request type BasketRecommendationRequest\ \ is not enabled, an empty list is returned." operationId: getBasketRecommendations parameters: - name: basketID in: query description: The UUID of the basket to get recommendations for schema: type: string description: The UUID of the basket to get recommendations for example: 56z8zttzCtzgtzAAAF1ut8DHYjo example: 56z8zttzCtzgtzAAAF1ut8DHYjo - name: RecommendationContextKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' "400": description: Bad Request - Missing parameter "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.BasketRequestRecommendationsListResource.getBasketRecommendations(java.lang.String) x-origin-class: com.intershop.component.recommendation.capi.rest.resource.BasketRequestRecommendationsListResource /recommendationcontexts/{RecommendationContextKey}/events: post: tags: - Recommendation Event summary: Creates a new recommendation context description: |- This operation creates a new recommendation context. This requires a configured recommendation service. To use this operation, specify one of the following events in the request body: - ProductViewRecommendationEvent - The product with the given productID [SKU] that has been viewed. - BasketRecommendationEvent - The items that have been added to the basket. - OrderRecommendationEvent - The items that were ordered or the order with the specified orderID that was submitted. - SearchRecommendationEvent - A search with the given searchTerm that has been processed. - UserRecommendationEvent - Connects the current recommendation context with the given userID. This event may affect the results of the recommendation requests. The event can only be sent successfully if the installed recommendation engines support the event type and if the corresponding back office preferences of the channel (Preferences | Recommendation Engines) are enabled for the given event type. All events which are sent to the recommendation engine will be tagged with the RecommendationContextKey to express that they belong to a specific session. See the description of "POST /recommendationcontexts". operationId: sendEvent parameters: - name: RecommendationContextKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/RecommendationEventRO' text/xml: schema: $ref: '#/components/schemas/RecommendationEventRO' responses: "204": description: No content "400": description: Bad Request - Unknown event type "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource.sendEvent(com.intershop.component.recommendation.capi.rest.resourceobject.RecommendationEventRO) x-origin-class: com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource /recommendationcontexts/{RecommendationContextKey}/productrecommendations: get: tags: - Recommendation Request summary: Returns recommended products for the given product (SKU) description: "This operation returns a list of recommended products for the\ \ given product ID (SKU). This requires a configured recommendation service.\ \ The result list strongly depends on the configuration of the recommendation\ \ engine and on the back office preferences of the channel (Preferences |\ \ Recommendation Engines). If the request type ProductRecommendationRequest\ \ is not enabled, an empty list is returned." operationId: getProductRecommendations parameters: - name: productID in: query description: The SKU of the product to get recommendations for schema: type: string description: The SKU of the product to get recommendations for example: "124566" example: "124566" - name: RecommendationContextKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' "400": description: Bad Request - Missing parameter security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.ProductRequestRecommendationsListResource.getProductRecommendations(java.lang.String) x-origin-class: com.intershop.component.recommendation.capi.rest.resource.ProductRequestRecommendationsListResource /recommendationcontexts/{RecommendationContextKey}/searchrecommendations: get: tags: - Recommendation Request summary: Returns recommended products for the given search term description: "This operation returns a list of recommended products for the\ \ given search term. This requires a configured recommendation service. The\ \ result list strongly depends on the configuration of the recommendation\ \ engine and on the back office preferences of the channel (Preferences |\ \ Recommendation Engines). If the request type SearchRecommendationRequest\ \ is not enabled, an empty list is returned." operationId: getProductRecommendationsSearchRequest parameters: - name: searchTerm in: query description: The search term to get recommendations for schema: type: string description: The search term to get recommendations for example: Acer example: Acer - name: RecommendationContextKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' "400": description: Bad Request - Missing parameter security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.SearchRequestRecommendationsListResource.getProductRecommendations(java.lang.String) x-origin-class: com.intershop.component.recommendation.capi.rest.resource.SearchRequestRecommendationsListResource /recommendationcontexts/{RecommendationContextKey}/topsellerrecommendations: get: tags: - Recommendation Request summary: Returns recommended global top-selling products description: "This operation returns a list of recommended global top-selling\ \ products. This requires a configured recommendation service. The result\ \ list strongly depends on the configuration of the recommendation engine\ \ and on the back office preferences of the channel (Preferences | Recommendation\ \ Engines). If the request type TopsellerRecommendationRequest is not enabled,\ \ an empty list is returned." operationId: getProductRecommendationsTopsellerRequest parameters: - name: RecommendationContextKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.TopsellerRequestRecommendationsListResource.getProductRecommendations() x-origin-class: com.intershop.component.recommendation.capi.rest.resource.TopsellerRequestRecommendationsListResource /recommendationcontexts/{RecommendationContextKey}/userrecommendations: get: tags: - Recommendation Request summary: 'Returns recommended products for the assigned user / recommendation context ' description: "This operation returns a list of recommended products for the\ \ assigned user. This requires a configured recommendation service. The assignment\ \ of a user to the recommendation context must be done separately (see description\ \ of POST /recommendationcontexts/{RecommendationContextKey}/events - UserRecommendationEvent).\ \ If no user is assigned to the recommendation context, the delivered recommendations\ \ are of a general nature and not user-specific. The result list strongly\ \ depends on the configuration of the recommendation engine and on the back\ \ office preferences of the channel (Peferences | Recommendation Engines).\ \ If the request type UserRecommendationRequest is not enabled, an empty list\ \ is returned." operationId: getProductRecommendationsUserRequest parameters: - name: RecommendationContextKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.UserRequestRecommendationsListResource.getProductRecommendations() x-origin-class: com.intershop.component.recommendation.capi.rest.resource.UserRequestRecommendationsListResource components: schemas: LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true description: The list of elements ResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/AbstractResourceObject' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection BasketLineItemRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true productID: type: string quantity: type: integer format: int32 xml: name: BasketLineItem BasketRecommendationEventRO: type: object xml: name: BasketRecommendationEvent allOf: - $ref: '#/components/schemas/RecommendationEventRO' - type: object properties: items: type: array xml: name: BasketLineItems wrapped: true items: $ref: '#/components/schemas/BasketLineItemRO' OrderRecommendationEventRO: type: object xml: name: OrderRecommendationEvent allOf: - $ref: '#/components/schemas/RecommendationEventRO' - type: object properties: orderID: type: string items: type: array xml: name: OrderedItems wrapped: true items: $ref: '#/components/schemas/BasketLineItemRO' ProductViewRecommendationEventRO: type: object xml: name: ProductViewRecommendationEvent allOf: - $ref: '#/components/schemas/RecommendationEventRO' - type: object properties: productID: type: string RecommendationEventRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true xml: name: RecommendationEvent discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/ProductViewRecommendationEventRO' - $ref: '#/components/schemas/BasketRecommendationEventRO' - $ref: '#/components/schemas/OrderRecommendationEventRO' - $ref: '#/components/schemas/SearchRecommendationEventRO' - $ref: '#/components/schemas/UserRecommendationEventRO' SearchRecommendationEventRO: type: object xml: name: SearchRecommendationEvent allOf: - $ref: '#/components/schemas/RecommendationEventRO' - type: object properties: searchTerm: type: string UserRecommendationEventRO: type: object xml: name: UserRecommendationEvent allOf: - $ref: '#/components/schemas/RecommendationEventRO' - type: object properties: userID: type: string responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "300": description: Multiple Choices "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "308": description: Permanent Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "451": description: Unavailable For Legal Reasons "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD MXN: description: Mexican Peso value: MXN STD: description: São Tomé / Príncipe Dobra value: STD LVL: description: Latvian Lats value: LVL SCR: description: Seychelles Rupee value: SCR CDF: description: Congolese Franc value: CDF BBD: description: Barbados Dollar value: BBD GTQ: description: Guatemalan Quetzal value: GTQ CLP: description: Chilean Peso value: CLP HNL: description: Honduran Lempira value: HNL UGX: description: Ugandan Shilling value: UGX ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND BSD: description: Bahamian Dollar value: BSD SLL: description: Sierra Leonean Leone value: SLL SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD CUP: description: Cuban Peso value: CUP GMD: description: Gambian Dalasi value: GMD TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP AZN: description: Azerbaijanian Manat value: AZN OMR: description: Omani Rial value: OMR PGK: description: Papua New Guinean Kina value: PGK KES: description: Kenyan Shilling value: KES SEK: description: Swedish Krona value: SEK BTN: description: Ngultrum value: BTN UAH: description: Ukrainian Hryvnia value: UAH GNF: description: Guinea Franc value: GNF ERN: description: Nakfa value: ERN MZN: description: Mozambican Metical value: MZN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR IRR: description: Iranian Rial value: IRR NLG: description: Dutch Guilder value: NLG MRO: description: Mauritanian Ouguiya value: MRO CNY: description: Yuan Renminbi value: CNY THB: description: Thai Baht value: THB UZS: description: Uzbekistani Som value: UZS XPF: description: CFP Franc value: XPF BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD KWD: description: Kuwaiti Dinar value: KWD PHP: description: Philippine Peso value: PHP RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG ISK: description: Iceland Krona value: ISK JMD: description: Jamaican Dollar value: JMD GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP MKD: description: Denar value: MKD USD: description: US Dollar value: USD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB KGS: description: Som value: KGS SOS: description: Somali Shilling value: SOS VEF: description: Venezuelan Bolivar Fuerte value: VEF VUV: description: Vanuatu Vatu value: VUV LAK: description: Lao Kip value: LAK BND: description: Brunei Dollar value: BND ZMK: description: Zambian Kwacha value: ZMK XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ATS: description: Austrian Schilling value: ATS CHF: description: Swiss Franc value: CHF HRK: description: Croatian Kuna value: HRK ITL: description: Italian Lira value: ITL ALL: description: Albanian Lek value: ALL DJF: description: Djibouti Franc value: DJF MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS GHS: description: Ghanaian Cedi value: GHS GYD: description: Guyanese Dollar value: GYD KPW: description: North Korean Won value: KPW BOB: description: Boliviano value: BOB KHR: description: Cambodian Riel value: KHR MDL: description: Moldovan Leu value: MDL IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD BWP: description: Botswana Pula value: BWP SHP: description: Saint Helena Pound value: SHP TRY: description: Turkish Lira value: TRY CYP: description: Cyprus Pound value: CYP LBP: description: Lebanese Pound value: LBP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD AED: description: United Arab Emirates Dirham value: AED HKD: description: Hong Kong Dollar value: HKD RWF: description: Rwanda Franc value: RWF EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN EEK: description: Estonian Kroon value: EEK MMK: description: Kyat value: MMK MUR: description: Mauritian Rupee value: MUR NOK: description: Norwegian Krone value: NOK SYP: description: Syrian Pound value: SYP ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN CRC: description: Costa Rican Colon value: CRC CZK: description: Czech Koruna value: CZK IEP: description: Irish Pound value: IEP PKR: description: Pakistani Rupee value: PKR GRD: description: Greek Drachma value: GRD XCD: description: East Carribean Dollar value: XCD ANG: description: Netherlands Antillian Guilder value: ANG HTG: description: Haitian Gourde value: HTG BHD: description: Bahraini Dinar value: BHD SIT: description: Slovenian Tolar value: SIT PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP KZT: description: Kazakhstani Tenge value: KZT SRD: description: Surinam Dollar value: SRD SZL: description: Swazi Lilangeni value: SZL LTL: description: Lithuanian Litas value: LTL SAR: description: Saudi Riyal value: SAR TTD: description: Trinidad and Tobago Dollar value: TTD YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR AFN: description: Afghani value: AFN BPV: description: Bonus Point Value value: BPV INR: description: Indian Rupee value: INR AWG: description: Aruban Florin value: AWG KRW: description: South Korean Won value: KRW NPR: description: Nepalese Rupee value: NPR JPY: description: Japanese Yen value: JPY MNT: description: Mongolian Tugrik value: MNT AOA: description: Angolan Kwanza value: AOA PLN: description: Polish Złoty value: PLN GBP: description: Pound Sterling value: GBP SBD: description: Solomon Islands Dollar value: SBD HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM BZD: description: Belize Dollar value: BZD DEM: description: Deutsche Mark value: DEM BAM: description: Convertible Marks value: BAM EGP: description: Egyptian Pound value: EGP MOP: description: Macanese Pataca value: MOP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN NZD: description: New Zealand Dollar value: NZD WST: description: Samoan Tala value: WST TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: recommendation x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource"