How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coveo Listings API

The Listings API from Coveo — 1 operation(s) for listings.

Coveo Listings API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Listings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

1 operations 1 paths 40 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Listings API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Listings 1
POST
/rest/organizations/{organizationId}/commerce/v2/listing
Get a Listing Page
getListing 1 param body → 200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are ListingRequestModel_V2ProductView (13 properties), HierarchicalFacetResultValue_V2ProductView (9 properties), DateRangeFacetResultValue_V2ProductView (8 properties), NumericalRangeFacetResultValue_V2ProductView (8 properties). Each schema is shown below with its type and property counts.

LegacyFacetOptions_V2ProductView
object
Facet Options for legacy (v1) facets.
1 property
ContextModel_V2ProductView
object
Contextual information about the query.
7 properties 1 required
NumericalRangeFacetResult_V2ProductView
object
SortResponseModel_V2ProductView
object
The applied and available sort options for the query.
2 properties
DateRangeFacetResult_V2ProductView
object
HierarchicalValueModel_V2ProductView
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 1 required
ProductForPreview_V2ProductView
object
HierarchicalFacetModel_V2ProductView
object
Hierarchical (tree-like) facet.
2 required
SortByFieldsRequestResponseModel_V2ProductView
object
1 required
BadgePlacementViewModel_V2ProductView
object
The list of badge placements associated with this product.
2 properties
AbstractFacetResultObject_V2ProductView
object
The available facets. Note that this array will always be empty in the '/productSuggest' endpoint.
6 properties 1 required
RequestFacetBaseObject_V2ProductView
object
The facet operations to perform on the query. Note that this parameter is ignored in the '/productSuggest' endpoint.
6 properties 2 required
PaginationResponseModel_V2ProductView
object
Contextual pagination information about the query.
6 properties
ListingRequestModel_V2ProductView
object
The listing query to be executed.
13 properties 5 required
RegularFacetResultValue_V2ProductView
object
6 properties
NumericalRangeFacetModel_V2ProductView
object
Numerical range facet.
2 required
HierarchicalFacetResultValue_V2ProductView
object
9 properties
RangeDomain_V2ProductView
object
Limits the range values to the specified domain.
3 properties 2 required
SortByRelevanceRequestResponseModel_V2ProductView
object
HierarchicalFacetResult_V2ProductView
object
AbstractSortRequestResponseModel_V2ProductView
object
Determines the order in which to retrieve the results.
1 property
Result_V2ProductView
object
List of results including products and spotlight content
1 property 1 required
NumericalRangeValueModel_V2ProductView
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 2 required
BadgeViewModel_V2ProductView
object
The list of badges associated with this placement
4 properties
RegularFacetResult_V2ProductView
object
Product_V2ProductView
object
TriggerModel_V2ProductView
object
The actions for the client to perform based on the Trigger statements defined.
2 properties
RegularFacetModel_V2ProductView
object
Regular (single string value) facet.
2 required
CartItemModel_V2ProductView
object
A purchased item.
2 properties
ChildProduct_V2ProductView
object
SpotlightContentModel_V2ProductView
object
Spotlight Content
2 required
ViewModel_V2ProductView
object
A collection of data points describing the view. Note: The term 'view' is used instead of 'page' to accommodate usage in contexts such as mobile apps.
2 properties 1 required
RegularValueModel_V2ProductView
object
The values displayed by the facet in the search interface at the moment of the request.
3 properties 1 required
DateRangeFacetModel_V2ProductView
object
Date range facet.
2 required
UserModel_V2ProductView
object
The user information.
1 property
DateRangeValueModel_V2ProductView
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 2 required
DateRangeFacetResultValue_V2ProductView
object
8 properties
SortByFieldRequestResponseModel_V2ProductView
object
Defines the fields and, optionally, their sort order.
3 properties 1 required
ListingResponseModel_V2ProductView
object
7 properties
NumericalRangeFacetResultValue_V2ProductView
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-listings-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Listings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.