openapi: 3.0.1 info: title: Rating & Review description: "The Intershop Rating & Review REST API contains operations that allow\ \ to create, retrieve and delete reviews. " 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: TestRestEnterprise-TestRestSalesChannel-Site appUrl: description: The application URL identifier enum: - rest - rest - rest - rest default: rest tags: - name: Rating and Review description: "The following operations for creating, retrieving and deleting reviews\ \ are available:" x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource paths: /categories/{categoriesKey}/products/{productKey}/reviews: post: tags: - Rating and Review summary: Creates a review for product description: This operation submits a user review for a product. operationId: addReview_1 parameters: - name: categoriesKey in: path description: The category ID required: true schema: type: string description: The category ID example: "153" example: "153" x-item-key: com.intershop.sellside.rest.common.capi.resource.category.CategoryListResource - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/NewReviewRO' text/xml: schema: $ref: '#/components/schemas/NewReviewRO' responses: "201": description: Created - The review was successfully created. content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: Bad Request - At least one attribute is missing or invalid. "404": description: Not found - The product could not be found. "401": description: Unauthorized - The user could not be authenticated. "422": description: Unprocessable Entity - The customer already created a review for this product. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.addReview(com.intershop.sellside.rest.common.capi.resourceobject.NewReviewRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource /categories/{categoriesKey}/products/{productKey}/reviews/{ReviewKey}: delete: tags: - Rating and Review summary: Deletes product review by ID description: This operation deletes a specific user review of a specific product. operationId: deleteProductReviewByIDDELETEReviews_1 parameters: - name: categoriesKey in: path description: The category ID required: true schema: type: string description: The category ID example: "153" example: "153" x-item-key: com.intershop.sellside.rest.common.capi.resource.category.CategoryListResource - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource - name: ReviewKey in: path description: The review ID required: true schema: type: string description: The review ID example: aUAKDgAFMa8AAAF2XvNMKHUM example: aUAKDgAFMa8AAAF2XvNMKHUM x-item-key: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource responses: "204": description: No content - The review was successfully deleted. "404": description: Not found - The product or review could not be found. "403": description: Forbidden - The supplied user is not allowed to delete this review. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public void com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.deleteProductReviewByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource /products/{productKey}/reviews: post: tags: - Rating and Review summary: Creates review for a product description: This operation submits a user review for a product. operationId: addReview parameters: - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/NewReviewRO' text/xml: schema: $ref: '#/components/schemas/NewReviewRO' responses: "201": description: Created - The review was successfully created. content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: Bad Request - At least one attribute is missing or invalid. "404": description: Not found - The product could not be found. "401": description: Unauthorized - The user could not be authenticated. "422": description: Unprocessable Entity - The customer already created a review for this product. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.addReview(com.intershop.sellside.rest.common.capi.resourceobject.NewReviewRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource /products/{productKey}/reviews/{ReviewKey}: delete: tags: - Rating and Review summary: Deletes product review by ID description: This operation deletes a specific user review of a specific product. operationId: deleteProductReviewByIDDELETEReviews parameters: - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource - name: ReviewKey in: path description: The review ID required: true schema: type: string description: The review ID example: aUAKDgAFMa8AAAF2XvNMKHUM example: aUAKDgAFMa8AAAF2XvNMKHUM x-item-key: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource responses: "204": description: No content - The review was successfully deleted. "404": description: Not found - The product or review could not be found. "403": description: Forbidden - The supplied user is not allowed to delete this review. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public void com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.deleteProductReviewByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource /categories/{categoriesKey}/products{spgid}/{productKey}/reviews/{ReviewKey}: get: tags: - Rating and Review summary: Returns product review by ID description: This operation returns a specific user review of a specific product. operationId: getProductReviewByIDGETReviews_1 parameters: - $ref: '#/components/parameters/spgid' x-matrixParamPath: products - name: categoriesKey in: path description: The category ID required: true schema: type: string description: The category ID example: "153" example: "153" x-item-key: com.intershop.sellside.rest.common.capi.resource.category.CategoryListResource - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource - name: ReviewKey in: path description: The review ID required: true schema: type: string description: The review ID example: aUAKDgAFMa8AAAF2XvNMKHUM example: aUAKDgAFMa8AAAF2XvNMKHUM x-item-key: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource responses: "200": description: OK - The review with the given ID. content: application/json: schema: $ref: '#/components/schemas/ReviewRO' text/xml: schema: $ref: '#/components/schemas/ReviewRO' "401": description: Unauthorized - The user could not be authenticated. "404": description: Not found - The product or review could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.ReviewRO com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.getProductReviewByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource /products{spgid}/{productKey}/reviews: get: tags: - Rating and Review summary: Returns reviews of a product description: This operation returns a list of all user reviews for a product. operationId: getProductReviewsGET parameters: - $ref: '#/components/parameters/spgid' x-matrixParamPath: products - name: attrs in: query description: | `attrs` can contain the following attribute names separated by comma: - `authorname`: Name of the author (firstname and lastname, showAuthorNameFlag) - `content`: Content of the review - `creationdate`: Creation date of the review - `rating`: Rating of the review (0..5) - `status`: Status of the review (NEW, APPROVED) - `title`: Title of the review - `localeid`: Locale id of the review - `own`: Flag if the review is owned by the requested user schema: type: string description: | `attrs` can contain the following attribute names separated by comma: - `authorname`: Name of the author (firstname and lastname, showAuthorNameFlag) - `content`: Content of the review - `creationdate`: Creation date of the review - `rating`: Rating of the review (0..5) - `status`: Status of the review (NEW, APPROVED) - `title`: Title of the review - `localeid`: Locale id of the review - `own`: Flag if the review is owned by the requested user example: "status,rating" example: "status,rating" - name: own in: query description: | Flag that determines if the review list should contain only reviews owned by the requested user or only reviews from other authors. If the flag is omitted, all reviews are returned. schema: type: boolean description: | Flag that determines if the review list should contain only reviews owned by the requested user or only reviews from other authors. If the flag is omitted, all reviews are returned. example: false example: "false" - name: localespecific in: query description: Flag that determines if the review list should contain reviews for the requested locale or all reviews independent from the requested locale. schema: type: boolean description: Flag that determines if the review list should contain reviews for the requested locale or all reviews independent from the requested locale. example: false default: false example: "false" - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource responses: "200": description: OK - The reviews for the given product. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "404": description: Not found - The product could not be found. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO\ \ com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.getProductReviews(java.lang.String,java.lang.Boolean,java.lang.Boolean)" x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource /products{spgid}/{productKey}/reviews/{ReviewKey}: get: tags: - Rating and Review summary: Returns product review by ID description: This operation returns a specific user review of a specific product. operationId: getProductReviewByIDGETReviews parameters: - $ref: '#/components/parameters/spgid' x-matrixParamPath: products - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource - name: ReviewKey in: path description: The review ID required: true schema: type: string description: The review ID example: aUAKDgAFMa8AAAF2XvNMKHUM example: aUAKDgAFMa8AAAF2XvNMKHUM x-item-key: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource responses: "200": description: OK - The review with the given ID. content: application/json: schema: $ref: '#/components/schemas/ReviewRO' text/xml: schema: $ref: '#/components/schemas/ReviewRO' "401": description: Unauthorized - The user could not be authenticated. "404": description: Not found - The product or review could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.ReviewRO com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.getProductReviewByID() x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource /categories/{categoriesKey}/products{spgid}/{productKey}/reviews: get: tags: - Rating and Review summary: Returns reviews of a product description: This operation returns a list of all user reviews for a product. operationId: getProductReviewsGET_1 parameters: - $ref: '#/components/parameters/spgid' x-matrixParamPath: products - name: attrs in: query description: | `attrs` can contain the following attribute names separated by comma: - `authorname`: Name of the author (firstname and lastname, showAuthorNameFlag) - `content`: Content of the review - `creationdate`: Creation date of the review - `rating`: Rating of the review (0..5) - `status`: Status of the review (NEW, APPROVED) - `title`: Title of the review - `localeid`: Locale id of the review - `own`: Flag if the review is owned by the requested user schema: type: string description: | `attrs` can contain the following attribute names separated by comma: - `authorname`: Name of the author (firstname and lastname, showAuthorNameFlag) - `content`: Content of the review - `creationdate`: Creation date of the review - `rating`: Rating of the review (0..5) - `status`: Status of the review (NEW, APPROVED) - `title`: Title of the review - `localeid`: Locale id of the review - `own`: Flag if the review is owned by the requested user example: "status,rating" example: "status,rating" - name: own in: query description: | Flag that determines if the review list should contain only reviews owned by the requested user or only reviews from other authors. If the flag is omitted, all reviews are returned. schema: type: boolean description: | Flag that determines if the review list should contain only reviews owned by the requested user or only reviews from other authors. If the flag is omitted, all reviews are returned. example: false example: "false" - name: localespecific in: query description: Flag that determines if the review list should contain reviews for the requested locale or all reviews independent from the requested locale. schema: type: boolean description: Flag that determines if the review list should contain reviews for the requested locale or all reviews independent from the requested locale. example: false default: false example: "false" - name: categoriesKey in: path description: The category ID required: true schema: type: string description: The category ID example: "153" example: "153" x-item-key: com.intershop.sellside.rest.common.capi.resource.category.CategoryListResource - name: productKey in: path description: The product SKU required: true schema: type: string description: The product SKU example: "10809311" example: "10809311" x-item-key: com.intershop.sellside.rest.common.capi.resource.ProductListResource responses: "200": description: OK - The reviews for the given product. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "404": description: Not found - The product could not be found. "401": description: Unauthorized - The user could not be authenticated. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO\ \ com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.getProductReviews(java.lang.String,java.lang.Boolean,java.lang.Boolean)" x-origin-class: com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource 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 NewReviewRO: title: NewReview 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. ' example: NewReview xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' title: type: string description: The title of the new review example: Good choice content: type: string description: The content of the review example: I am satisfied with my purchase. The quality is very good for the price. I still wish there were more features. rating: type: integer description: The rating of the product from 0 to 5 format: int32 example: 5 showAuthorNameFlag: type: boolean description: If rendered and true the reviewer can decide to show the name example: true attribute: $ref: '#/components/schemas/ResourceAttribute' xml: name: Review LinkROResourceCollectionRO: 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/LinkRO' 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: This resource holds a list of Link-ResourceObjects. xml: name: ResourceCollection ResourceCollectionROLinkRO: title: Link List 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/LinkRO' type: type: string description: "This is a constant: **ResourceCollection**" example: ResourceCollection 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 the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection ReviewRO: title: Review 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. ' example: Review xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' authorFirstName: type: string description: The first name of the author example: Alexandra authorLastName: type: string description: The last name of the author example: Heimroth title: type: string description: The title of the review example: Good choice content: type: string description: The content of the review example: I am satisfied with my purchase. The quality is very good for the price. I still wish there were more features. id: type: string description: The ID of the review example: y60KDACwgR8AAAFB0MKGQOQj creationDate: type: string description: The creation date of the review format: date-time rating: type: integer description: The rating of the product from 0 to 5 format: int32 example: 5 status: type: string description: The status of the review example: NEW (NOT APPROVED) statusCode: type: string description: "The status code of the review. If no approval is necessary\ \ for reviews, all created reviews are automatically in status \"APPROVED\"\ ." example: "[NEW, APPROVED, REJECTED]" showAuthorNameFlag: type: boolean description: If rendered and true the reviewer can decide to show the name example: true localeID: type: string description: The ID of the review's locale example: en_US own: type: boolean description: Flag that shows if the review is created and owned by the currently authenticated user example: false attribute: $ref: '#/components/schemas/ResourceAttribute' xml: name: Review responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary 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 "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 STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP 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 PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL 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 KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED 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 MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR 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 IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Zloty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP 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 DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP 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 WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD 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: rating-review x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource,com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource"