Commerce API

Manage orders, subscriptions, and agreements using the Commerce API

The Commerce API enables you to create, retrieve, and manage your orders, subscriptions, and agreements within the SoftwareOne Marketplace. With this API, you can also:

• Create new assets and manage the existing ones.

• Check the details of a specific order by its ID.

• Delete orders that are still in draft status (not yet submitted).

• Fail orders that can't be completed.

• Update, process, or complete orders as needed.

• Retrieve and manage files attached to agreements.

• Validate requests and manage the status of those requests.

Try APIDownload API

Core Concepts

The Commerce API is built around the following core resources:

• Asset - Represents a one-time purchased item or a perpetual license associated with an agreement.

• Agreement - Defines the relationship between the seller, buyer, and licensee.

• Request - Represents a request to the platform.

• Order - Represents a request to create or modify an agreement, including purchasing, changing, or terminating subscriptions within an agreement..

• Subscription - Represents a collection of items within the agreement. All items are connected to one product, one vendor, and one client (the same as the agreement) and have the same billing frequency and commitment terms.

Collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Assets

Capability	Client	Vendor	Operations
List assets	✅	✅	✅
Get asset	✅	✅	✅
Create asset	❌	✅	❌
Update asset	✅	✅	✅
Terminate asset	❌	✅	❌
Render an asset’s template by id	✅	✅	✅

Agreements

Capability	Client	Vendor	Operations
List agreements	✅	✅	✅
Get agreement	✅	✅	✅
Create agreements	❌	❌	✅
Update agreements	✅	✅	✅
Render agreement template	✅	✅	✅
List agreement attachments	✅	✅	✅
Get agreement attachment	✅	✅	✅
Create agreement attachment	❌	✅	✅
Delete agreement attachment	❌	✅	✅

Orders

Capability	Client	Vendor	Operations
List orders	✅	✅	✅
Get order	✅	✅	✅
Create order	✅	❌	❌
Update order	✅	✅	✅
Validate order	✅	✅	❌
Process order	✅	✅	✅
Query order	❌	✅	❌
Complete order	❌	✅	❌
Fail order	❌	✅	✅
Remind client about an order	❌	❌	✅
Delete order	✅	❌	❌
Render order template	✅	✅	✅

Order Subscription

Capability	Client	Vendor	Operations
List subscriptions	✅	✅	✅
Get order subscription	✅	✅	✅
Create order subscription	❌	✅	❌
Update order subscription	❌	✅	❌
Remove order subscription

Order Assets

Capability	Client	Vendor	Operations
List all order assets	✅	✅	✅
Create order asset	❌	✅	❌
Update order asset	✅	✅	✅
Delete order asset	❌	✅	❌

Requests

Capability	Client	Vendor	Operations
List requests	✅	✅	✅
Get request	✅	❌	✅
Create request	❌	✅	❌
Update request	❌	✅	✅
Validate request	✅	✅	✅
Process request	✅	✅	✅
Query request	❌	✅	✅
Complete request	✅	✅	✅
List request messages	✅	✅	✅
Get request message	✅	✅	✅
Create request message	✅	✅	✅
List request attachments	✅	✅	✅
Get request attachment	✅	✅	✅
Create request attachment	✅	✅	✅
Delete request attachment	✅	✅	✅

Subscriptions

Capability	Client	Vendor	Operations
List subscriptions	✅	✅	✅
Get subscription	✅	✅	✅
Create subscription	❌	✅	❌
Update subscription	✅	✅	✅
Terminate subscription	❌	✅	❌
Render subscription template	✅	✅	✅