Commerce API
Use the Commerce API to manage orders, subscriptions, and agreements programmatically.
The Commerce API enables you to create, retrieve, and manage orders, subscriptions, and agreements within the Marketplace Platform.
With this API, you can:
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.
Before you start
Review the shared API docs before you work with commerce resources.
Core resources
The Commerce API is built around the following core resources:
Agreement – Defines the relationship between the
seller,buyer, andlicensee.Asset – Represents a one-time purchased item or a perpetual license associated with an agreement.
Order – Represents a request to create or modify an agreement, including purchasing, changing, or terminating
subscriptionswithin an agreement.Order asset – Represents an asset created and managed in the context of an order.
Order subscription – Represents a subscription created and managed in the context of an order.
Request – Represents a request to the platform.
Subscription – Represents a collection of items within the agreement. All items are connected to one
product, one vendor, and one client, and share the same billing frequency and commitment terms.
Browse 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.
Use the following links to jump to the collection you need:
Assets
Agreements
Orders
Order Subscriptions
Order Assets
Requests
Subscriptions
Last updated
Was this helpful?