Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
List items in the Agreements collection.
Get a single Agreement object by ID.
Field | Type | Description |
---|---|---|
id
string
Primary account identifier.
Example: "AGR-2119-4550-8674"
href
string
Relative reference to object on API (always /commerce/agreements/{id}).
Example: "/v1/commerce/agreements/AGR-2119-4550-8674"
status
string
The key status of the object. May only be specified on creation - Draft or Provisioning, and cannot be updated with PUT
.
name
string
Agreement name, will be assigned automatically on creation, as {product.name} for
{licensee.name}
but can be changed later.
Example: "Microsoft Office 365 NCE E1"
vendor
client
buyer
seller
licensee
product
listing
Listing
Reference to the listing which allows this agreement.
Example:
authorization
Authorization
Reference to the Authorization object used for the agreement.
Example:
price
Price
The price for the agreement, explains the monthly and yearly prices for the whole agreement, one-time price tags are never included into it. different parts of price object visible to different actors, see Price Object.
Example:
template
Template
Reference to Template object.
Example:
error
ErrorObject
Markup text string explaining reason for provisining failure. Always set on moving status to Failed.
Example:
lines
Lines[]
List of items in Agreement.
Example:
subscriptions
Subscription[]
Example:
parameters.fulfillment
OrderParameterValue []
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
parameters.ordering
Order Parameter Object []
An object that holds a concise definition of a parameter, its value, and any associated errors.
Example:
audit
AuditObject
Audit object with possible entries: created, updated, activated, terminated, according to the object's lifecycle.
Possible audit events include Created, Updated, Activated, Terminated, and Failed.
Example:
externalIds
ExternalIdsObject
Set of external IDs.
Example:
Field | Type | Description |
---|
| string | Primary Request identifier Example: "REQ-1671-0642" |
| string | Relative reference to object on API (always /v1/commerce/requests/{id}) Example: "/v1/commerce/requests/REQ-1671-0642" |
| string | Status of the request. Example: "Querying" |
| Reference to client Account object. Example: |
| Reference to vendor Account object. Example: |
| User of requester, in client account. Example: |
| User of vendor who is responsible to processing request. Example: |
| Product | Example: |
| ExternalIdsObject | Set of external IDs identifiers. Example: |
| ParameterValue[] | Request ordering parameters values Example: |
| ErrorObject | Error reported by validation procedure. Example: |
| AuditObject | Audit object with possible entries: created, updated, activated, terminated, according to lifecycle of the object. Possible audit events: Created, Updated, and Querying. Example: |
Get a list of requests.
Update some properties (assignee
and externalIDs
) of a request.
Get a single request by ID.
Get a single request message.
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|
Field | Description |
---|
id
string
Primary message identifier
Example: "MSG-1212-3434-5656-7878"
href
string
Relative reference to object on API (always /v1/somewhere/items/{id})
Example: "/v1/commerce/requests/REQ-1671-0642/messages/MSG-1212-3434-5656-7878"
type
string
Type of message: User or System.
Example: "User"
content
string
Message contents
Example: "I would agree discount of 5%".
request
Reference to request, never sent in context of the Request - i.e. not set on subcollection /commerce/request/{id}/messages, but will be sent whithout this context.
Example:
audit
AuditObject
Audit object with possible entries: Created.
Example:
| string | Inline attachment content. For example, in the case of type LicenseKey, this field is actually populated with a license key string. Example: "DFE25-GQ943-GH992-KL235-PY037" |
id | Primary attachment identifier using the prefix “ATT”. Example: "ATT-1234-1234-1234" |
classification | File or License Key Example: "File" |
status | Attachment status. Can be Published or Deleted. Example: "Published" |
Get an attachment in the scope of the specific request.
List attachments in the scope of the specific request.
Create a request attachment.
Get a list of subscriptions in all agreements.
Get a list of subscriptions in all agreements.
The subscriptions
object represents a collection of Product Items inside the Agreement. All items are connected to one Product, one vendor, and one client (the same as the agreement) and have common billing frequency and commitment terms.
This object contains the following properties:
An order is a request made by a buyer to create/update an agreement with a one-time purchase or/and set of subscriptions. There are three types of Orders.
Purchase - A purchase order is the first order created in the lifecycle of an agreement. The purchase order is always the first order and there is only one within an agreement.
Change - A change order is a request to update the agreement. There can be multiple change orders in an agreement.
Termination - A termination order is a request to terminate the agreement or terminate a specific subscription within the agreement. There can be multiple termination orders.
Field | Type | Description |
---|
Field | Type | Description |
---|
id | string | Human Friendly identifier of Subscription object. Example: "SUB-2119-4550-8674-5962" |
href | string | Relative reference to object on API (always Example: "/v1/commerce/subscriptions/SUB-2119-4550-8674-5962)" |
status | string | The key status of the object. Possible values are a by-product of the latest completed order that touched this subscription. Possible statuses are a subset of all subscription statuses. Example: "Active" |
name | string | Subscription name. Example: Subscription for Microsoft Office 365 NCE E1 |
agreement | Agreement | Agreement that holds this particular Subscription instance. Example: |
product | Product | Product reference Example: |
startDate | string | Effective date of subscription start may be not defined in sciope of order). Example: "2023-12-14T17:28:57Z" |
commitmentDate | string | Date when subscription commitment ends and subscription to be renewed. Example: "2023-12-14T17:28:57Z" |
terminationDate | string | Date when subscription to be terminated. Example: "2023-12-14T17:28:57Z" |
terms | Terms | Subscription billing terms. Example: |
price | Price | Price for subscription, not all fields visible for everyone see details in Price, most of the object should be READONLY as it is calculated on orders completion, with only exception OPS can edit default markup for an active subscriptions. Example: |
lines | Lines[] | List of all product items (lines) purchasedi n scope of this subscription. Example: |
parameters | object | An object that groups together separate lists of parameters. Only fulfillment parameters are available in this object. Example: |
parameters.fulfillment | Order Parameter Object | An object that holds a concise definition of a parameter, its value, and any associated errors. Example: |
audit | AuditObject | Audit object with possible entries: created, updated, activated, terminated, according to the object's lifecycle. Possible audit events: Created, Updated, Activated, Terminated, and Failed. Example: |
externalIDs | ExternalIDsObject | Set of external IDs. Example: |
| string | Primary order identifier Example: "ORD-5542-1187-3130-0991" |
| string | Relative reference to object on API (always /commerce/orders/{id}) Example: "/commerce/orders/ORD-5542-1187-3130-0991" |
| string | Specified on creation of order, cannot be updated. Example: "Purchase" |
| string | Example: "Processing" |
| ExternalIds | External IDs for either client/vendor/distributor. Example: |
| string | Contains initial customer notes added by Buyer during purchase process. Buyer can edit and add notes at any time for all order statuses. Managed by client. Not used by vendor extensions. Example: "Order of 2 subs for 2 ppl from accounting dept." |
| Message Object | Notes added during status change by vendor or vendor extensions to indicate reason of order failure or status change. Should be shown on order screen (as part of template or standalone). Example: |
| Message Object | Standard error object. Means some error appeared on parameters validation, which can include markup. Used to indicate validation error by vendor or vendor extension during order validation. Should be reflected in purchase wizard while parameters validation and on the parameters and the items screens of order. Should behave like errors in parametes, i.e. reset on order status changes. Example: |
| Agreement | The agreement represents an instance of a relationship between Seller, Buyer, and Licensee. It may refer to one-time purchases or/and set of subscriptions. Example: |
| Authorization | Reference to Authorization object which was used for ther order. Example: |
| Listing | Reference to Listing which was used for the order. Example: |
| Template | Example: |
| User | Example: |
| AuditObject | AuditObject is a dictionary with events that happened with the object, every event has “at” part which specifies the last time the event occurred, and “by” part which specifies who the actor executed the event. Example: |
| Line[] | An Order Lines contains the information about the specific item the Buyer is purchasing/updating. Example: |
| Order Parameter Object [] | An object that holds a concise definition of a parameter, its value, and any associated errors. Example: |
| Order Parameter Object [] | An object that holds a concise definition of a parameter, its value, and any associated errors. Example: |
| Subscription | List of subscription references, for these subscriptions that going to be added/updated by the order. On POST or PUT, lines property of subscription can be provided to reflect these changes. Example: |
| Price | This represents the total price for an Order and is displayed to the various actors. Object is
Please note not all fields are visible to all actors. Example: |
List orders that the user has access to.
Returns list of all subscriptions for the order.
Creates a new subscription and adds it to the order.
Returns subscription with a given ID that exists in the order.
Create a new request.