openapi: 3.0.1
info:
title: Coveo Commerce API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
paths:
/rest/organizations/{organizationId}/commerce/v2/tracking-ids/{trackingId}/facet/fields/bulk-update:
put:
tags:
- Facet Field Configurations
summary: Update Multiple Facet Fields
description: 'Updates multiple facet fields.Maximum 100 items per request.</br></br>**Required privilege:** Merchandising
Hub - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{trackingId}"}
```
</details>'
operationId: bulkUpdate
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: path
description: The unique identifier of the tracking target.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
oneOf:
- $ref: '#/components/schemas/ContinuousFacetFieldModel'
- $ref: '#/components/schemas/HierarchicalFacetFieldModel'
- $ref: '#/components/schemas/NumericalRangesFacetFieldModel'
- $ref: '#/components/schemas/RegularFacetFieldModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
oneOf:
- $ref: '#/components/schemas/ContinuousFacetFieldModel'
- $ref: '#/components/schemas/HierarchicalFacetFieldModel'
- $ref: '#/components/schemas/NumericalRangesFacetFieldModel'
- $ref: '#/components/schemas/RegularFacetFieldModel'
x-pretty-name: bulkUpdate
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/tracking-ids/paramId/facet/fields/bulk-update_put
/rest/organizations/{organizationId}/commerce/v2/tracking-ids/{trackingId}/context-mappings/{key}:
get:
tags:
- Context Mapping Configurations
summary: Get Context Mapping
description: 'Gets a specific context mapping by key.</br></br>**Required privilege:** Merchandising Hub - View<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: get
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: path
description: The unique identifier of the tracking target.
required: true
schema:
type: string
- name: key
in: path
description: The context mapping key
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ContextMappingModel'
x-pretty-name: get
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/tracking-ids/paramId/context-mappings/paramId_get
put:
tags:
- Context Mapping Configurations
summary: Update Context Mapping
description: 'Updates an existing context mapping by key</br></br>**Required privilege:** Merchandising Hub - Edit<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{trackingId}"}
```
</details>'
operationId: update
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: path
description: The unique identifier of the tracking target.
required: true
schema:
type: string
- name: key
in: path
description: The context mapping key
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContextMappingModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ContextMappingModel'
x-pretty-name: update
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/tracking-ids/paramId/context-mappings/paramId_put
delete:
tags:
- Context Mapping Configurations
summary: Delete Context Mapping
description: 'Deletes a specific context mapping by key.</br></br>**Required privilege:** Merchandising Hub - Edit<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{trackingId}"}
```
</details>'
operationId: delete
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: path
description: The unique identifier of the tracking target.
required: true
schema:
type: string
- name: key
in: path
description: The context mapping key
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: delete
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/tracking-ids/paramId/context-mappings/paramId_delete
/rest/organizations/{organizationId}/commerce/v2/search/synonyms/{synonymId}:
get:
tags:
- Synonym
summary: Get a Synonym Rule.
description: 'Retrieves a synonym rule.</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSynonym
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: query
description: The unique identifier of the tracking target.
required: true
schema:
type: string
example: acmecorporation_ca
- name: synonymId
in: path
description: A UUID identifying the synonym rule.
required: true
schema:
type: string
format: uuid
example: 58bb4b98-1daa-4767-8c15-90a0ea67645c
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SynonymModel'
x-pretty-name: getSynonym
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/search/synonyms/paramId_get
put:
tags:
- Synonym
summary: Edit Synonym Rule
description: 'Updates a synonym rule.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{trackingId}"}
```
</details>'
operationId: editSynonym
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: query
description: The unique identifier of the tracking target.
required: true
schema:
maxLength: 255
minLength: 1
type: string
example: acmecorporation_ca
- name: synonymId
in: path
description: A UUID identifying the synonym rule.
required: true
schema:
type: string
format: uuid
example: 58bb4b98-1daa-4767-8c15-90a0ea67645c
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SynonymModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SynonymModel'
x-pretty-name: editSynonym
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/search/synonyms/paramId_put
delete:
tags:
- Synonym
summary: Delete Synonym Rule.
description: 'Deletes a synonym rule.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{trackingId}"}
```
</details>'
operationId: deleteSynonym
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: query
description: The unique identifier of the tracking target.
required: true
schema:
type: string
example: acmecorporation_ca
- name: synonymId
in: path
description: A UUID identifying the synonym rule.
required: true
schema:
type: string
format: uuid
example: 58bb4b98-1daa-4767-8c15-90a0ea67645c
responses:
'204':
description: No Content
x-pretty-name: deleteSynonym
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/search/synonyms/paramId_delete
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}:
get:
tags:
- Recommendations Configuration
summary: Retrieves a Slot Configuration
description: 'Shows a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSlotConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/).
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SlotConfigurationModel'
x-pretty-name: getSlotConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/paramId_get
put:
tags:
- Recommendations Configuration
summary: Update a Slot Configuration
description: 'Updates a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an
[organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{body.trackingId}"}
```
</details>'
operationId: updateSlotConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/).
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlotConfigurationModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SlotConfigurationModel'
x-pretty-name: updateSlotConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{body.trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{body.trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/paramId_put
delete:
tags:
- Recommendations Configuration
summary: Deletes a Slot Configuration
description: 'Deletes a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an
[organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: deleteSlotConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/).
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
x-pretty-name: deleteSlotConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/paramId_delete
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/{configurationId}/settings:
get:
tags:
- Recommendations Configuration
summary: Retrieves Slot Settings
description: 'Shows slot settings in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:**
Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSlotSettings
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/).
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SlotSettingsModel'
x-pretty-name: getSlotSettings
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/paramId/settings_get
put:
tags:
- Recommendations Configuration
summary: Update Slot Settings
description: 'Updates slot settings in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:**
Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{body.trackingId}"}
```
</details>'
operationId: updateSlotSettings
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/).
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SlotSettingsModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SlotSettingsModel'
x-pretty-name: updateSlotSettings
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{body.trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{body.trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/paramId/settings_put
/rest/organizations/{organizationId}/commerce/v2/recommendations/slots/global/query-configuration:
get:
tags:
- Recommendations Configuration
summary: Retrieves a Global Query Configuration
description: 'Shows a Query configuration. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getGlobalQueryConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: query
description: The unique identifier of the tracking target.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Recommendation.QueryConfigurationModel'
x-pretty-name: getGlobalQueryConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/global/query-configuration_get
put:
tags:
- Recommendations Configuration
summary: Update a Global Query Configuration
description: 'Updates a Query configuration. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"EDIT","targetId":"{trackingId}"}
```
</details>'
operationId: updateGlobalQueryConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: trackingId
in: query
description: The unique identifier of the tracking target.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Recommendation.QueryConfigurationModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Recommendation.QueryConfigurationModel'
x-pretty-name: updateGlobalQueryConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: EDIT
targetId: '{trackingId}'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/recommendations/slots/global/query-configuration_put
/rest/organizations/{organizationId}/commerce/v2/listings/pages/bulk-update:
put:
tags:
- Public Listing Page API
summary: Update Multiple Listing Pages
description: 'Updates multiple Listing pages in a [listing](https://docs.coveo.com/en/m1sf3187/). Maximum 100 items
per request..</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"MERCHANDISING_HUB","type":"VIEW","targetId":"*"}
```
</details>'
operationId: bulkUpdate_1
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PublicListingPageRequestModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/PublicListingPageResponseModel'
x-pretty-name: bulkUpdate
x-required-privilege:
owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: MERCHANDISING_HUB
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/listings/pages/bulk-update_put
/rest/organizations/{organizationId}/commerce/v2/listing/preview/rules/{id}:
get:
tags:
- Listing Rule Preview
summary: Preview the Impact of a Listing Rule.
description: 'Returns a preview of products.</br></br>**Required privilege:** Execute Query<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","targetId":"*"}
```
</details>'
operationId: previewImpactOfRule
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: id
in: path
description: The unique identifier of the rule.
required: true
schema:
type: string
format: uuid
- name: previewUrl
in: query
description: The URL used to retrieve the products listings.
required: true
schema:
type: string
example: http://acme.com/summersale
- name: listingName
in: query
description: The name of the listing configuration.
required: true
schema:
type: string
example: My Product Listing
- name: listingId
in: query
description: The unique identifier of the listing configuration.
required: true
schema:
type: string
example: 644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b
- name: trackingId
in: query
description: The unique identifier of the tracking target.
required: true
schema:
type: string
example: acmecorporation_ca
- name: language
in: query
description: An ISO 639-1 language code.
required: true
schema:
type: string
example: en
- name: country
in: query
description: An ISO 3166-1 alpha-2 country code.
required: true
schema:
type: string
example: US
- name: currency
in: query
description: An ISO 4217 currency code.
required: true
schema:
type: string
example: USD
- name: page
in: query
description: The page of products to request.
required: false
schema:
type: integer
format: int32
example: 7
- name: perPage
in: query
description: The number of products per page. Note that a value greater than 100 may be rejected in the future.
required: false
schema:
type: integer
format: int32
example: 30
- name: isEditingGlobal
in: query
description: Whether the rule is for the global config.
required: false
schema:
type: boolean
default: false
- name: debug
in: query
description: Whether to include the execution report on a successful response.
required: false
schema:
type: boolean
default: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PreviewResponseModel_V2ProductView'
x-pretty-name: previewImpactOfRule
x-required-privilege:
owner: SEARCH_API
targetDomain: EXECUTE_QUERY
targetId: '*'
x-required-privileges:
- owner: SEARCH_API
targetDomain: EXECUTE_QUERY
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/commerce/v2/listing/preview/rules/paramId_get
put:
tags:
- Listing Rule Preview
summary: Preview the Impact of an Updated Listing Rule Vs Not Having the Rule, or If compareWithPreviousState Is True,
the Impact of a Rule Update Vs the Previous State of the Rule.
description: 'Returns a preview of products.</br></br>**Required privilege:** Execute Query<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","targetId":"*"}
```
</details>'
operationId: previewImpactOfUpdatingRule
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: id
in: path
description: The unique identifier of the rule.
required: true
schema:
type: string
format: uuid
- name: isEditingGlobal
in: query
description: Whether the rule is for the global config.
required: false
schema:
type: boolean
default: false
- name: compareWithPreviousSta
# --- truncated at 32 KB (387 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-commerce-openapi-original.yml