Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Widen Products API

Create, retrieve, update, and search products (Acquia Entries).

Widen Products API is one of 17 APIs that Widen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 12 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://api.widencollective.com/v2, https://api.widencollective.com/v1.

13 operations 12 paths 9 schemas 1 DELETE4 GET2 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.widencollective.com/v2
Authentication
HTTP Bearer
License
Proprietary
Resource Areas
1

Authentication & Security 1

Widen Products API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 Bearer token obtained from Acquia DAM.

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 1 DELETE, 4 GET, 2 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Products 13

Create, retrieve, update, and search products (Acquia Entries).

POST
/products
Create a new product
createProduct body → 201
POST
/products/search
Search for products
listProductsBySearchQuery body → 200
GET
/products/{id}
Retrieve a product by ID
retrieveProductById 1 param → 200
DELETE
/products/{id}
Delete a product
deleteProduct 1 param → 204
PUT
/products/{id}/rename
Rename a product
renameProduct 1 param body → 204
PUT
/products/{id}/attributes
Update product attribute values
updateAttributeValues 1 param body → 204
PUT
/products/{id}/product-category
Update product categories
updateProductCategory 1 param body → 204
PUT
/products/{id}/featured-image
Update product featured image
updateFeaturedImage 1 param body → 204
PUT
/products/{id}/parent-product
Update product parent
updateParentProduct 1 param body → 204
PUT
/products/{id}/product-type
Update product type
updateProductType 1 param body → 204
GET
/products/channels/{channel_id}
List products for a channel
listProductsForChannel 3 params → 200
GET
/product-categories
List product categories
listProductCategories 3 params → 200
GET
/product-types
List product types
listProductTypes 2 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are GetProductResult (10 properties), ProductAttribute (6 properties), PaginatedList (4 properties), ProductCategory (3 properties). Each schema is shown below with its type and property counts.

PaginatedList
object
4 properties
ListProductCategoriesResult
ProductAttribute
object
6 properties
GetProductResult
object
10 properties
ProductCategory
object
3 properties
CreateProductResult
object
1 property
ListProductTypesResult
ListProductsByChannelResult
SearchProductsResult

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

widen-products-api-openapi.yml Raw ↑

Other APIs Widen publishes across the network.

Widen Acquia-DAM-Webhooks API
Widen Analytics API
Widen Assets API
Widen Attributes API
Widen Categories API
Widen Channels API
Widen Collections API
Widen File-Formats API
Widen Integration-Links API
Widen Metadata API
Widen Orders API
Widen Search-Connector API