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 Orders API

Create and manage asset orders and conversions.

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

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

This API exposes 8 operations across 7 paths, and defines 7 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.

8 operations 7 paths 7 schemas 4 GET4 POST

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 Orders 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 8

Across 7 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 8

Create and manage asset orders and conversions.

POST
/order/items/removals
Check which items will be removed from an order (v1)
cleanOrderItems body → 200
POST
/order
Create an asset order (v1)
createOrder body → 201
GET
/order/uuid/{uuid}
Get order details by UUID (v1)
getOrderDetailByUUID 2 params → 200
GET
/order/seqNum/{seqNum}
Get order details by sequence number (v1)
getOrderDetailBySequenceNum 2 params → 200
POST
/order/uuid/{uuid}/zip
Create a zip archive for an order (v1)
createZipForOrder 1 param → 204
GET
/order/uuid/{uuid}/zip
Get zip archive status or download link (v1)
getZipStatusOrDownloadLink 1 param → 200
GET
/order/profile/internet
List internet order profiles (v1)
getDirectorInternetProfiles → 200
POST
/conversion/order/profile/uuid/{profileId}
List conversions for an order profile (v1)
getApplicableConversions 1 param body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are GetOrderDetailsResult (12 properties), GetZipStatusResult (5 properties), OrderItem (4 properties), ListConversionsForOrderResult (1 property). Each schema is shown below with its type and property counts.

GetZipStatusResult
object
5 properties
Contact
object
1 property
CleanAssetsResult
object
1 property
OrderItem
object
4 properties
ListOrderProfileResult
object
1 property
GetOrderDetailsResult
object
12 properties
ListConversionsForOrderResult
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

widen-orders-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 Products API
Widen Search-Connector API