id

string

Primary Request identifier

Example: "REQ-1671-0642"

href

string

Relative reference to object on API (always /v1/commerce/requests/{id})

Example: "/v1/commerce/requests/REQ-1671-0642"

status

string

Status of the request.

Example: "Querying"

client

Account

Reference to client Account object.

Example:

{ 
  "id": "ACC-1234-4444",
  "name": "stark industries"
}

vendor

Account

Reference to vendor Account object.

Example:

{ 
  "id": "ACC-1234-1111",
  "name": "Microsoft"
}

requester

User

User of requester, in client account.

Example:

{ 
  "id": "USR-1234-4444",
  "name": "John Smith"
}

assignee

User

User of vendor who is responsible to processing request.

Example:

{ 
  "id": "USR-1234-1111",
  "name": "Santa Claus"
}

product

Product

Example:

{
  "id": "PRD-1111-1111-1111",
  "href": "/catalog/products/PRD-1111-1111-1111",
  "name": "Microsoft Office 365 NCE",
  "icon": "/static/PRD-1111-1111-1111/logo.png"
}

externalIds

ExternalIdsObject

Set of external IDs identifiers.

Example:

{
  "client": "12345678",
  "operations":	"07bf766b-c767-4293-9ab3",
  "vendor": "ABC-2023-C07-dbeee0b302c0"
}

parameters.order

ParameterValue[]

Request ordering parameters values

Example:

[
  {
    "id": "PRM-1234-1234-1234-1234",
    "name": "Tennant Id",
    "externalId": "tennant_id",
    "constraints": { ... },
    "value": "69b73824-ce76-4866-ad47-b615ae9d8998",
  }
]

error

ErrorObject

Error reported by validation procedure.

Example:

{
     "id": "E001234",
     "message": "Agreement provisioning failed due to unavailability of the item"
}

audit

AuditObject

Audit object with possible entries: created, updated, activated, terminated, according to lifecycle of the object.

Possible audit events: Created, Updated, and Querying.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } }
}

inlineAttachmentContent

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"

id

string

Primary order identifier

Example: "ORD-5542-1187-3130-0991"

href

string

Relative reference to object on API (always /commerce/orders/{id})

Example: "/commerce/orders/ORD-5542-1187-3130-0991"

type

string

Specified on creation of order, cannot be updated.

Example: "Purchase"

status

string

Example: "Processing"

externalIds

ExternalIds

External IDs for either client/vendor/distributor.

Example:

{
  "client": "abc-123",
  "operations": "SO-1234-1234-1111"
}

notes

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."

statusNotes

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:

{
    "id": "E001234",
    "message": "Adobe cannot provision your subscription"
}

error

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:

{
    "id": "E001234",
    "message": "Order has incompatible items - eductation and goverment"
}

agreement

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:

{
    "id": "AGR-2119-4550-8674-5962",
    "href": "/commerce/agreements/AGR-2119-4550-8674-5962",
    "name": "Microsoft Office 365 NCE E1",
    "icon": null
}

authorization

Authorization

Reference to Authorization object which was used for ther order.

Example:

{
    "id": "AUT-1234-4567",
    "href": "/authorization/ATH-1234-45678",
    "name": "Salesforce Enterprise License"
}

listing

Listing

Reference to Listing which was used for the order.

Example:

{
    "id": "LST-1234-1234"
}

template

Template

Example:

{
    "id": "TPL-1234-4444",
    "href": "/products/product/PRD-1234-1234-1234/templates/TPL-1234-4444",
    "name": "Succesful Activation"
}

assignee

User

Example:

{
    "id": "TPL-1234-4444",
    "href": "/products/product/PRD-1234-1234-1234/templates/TPL-1234-4444",
    "name": "Succesful Activation"
}

audit

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:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "terminated": { "at": "...", "by": { } }
}

lines[]

Line[]

An Order Lines contains the information about the specific item the Buyer is purchasing/updating.

Example:

[
   {
      "id": "ALI-1234-1234-1234-0001",
      "item": {
        "id": "ITM-1234-1234-1234-0021",
        "name": "Adobe Illustrator"
      },
      "quantity": 10,
      "price": { ... },
      "subscription": { "id": "SUB-1234-1234-1234" }
    },
    {
      "id": "ALI-1234-1234-1234-0002",
      "item": {
        "id": "ITM-4444-4444-4444-0031",
        "name": "Adobe Photoshop"
      },
      "quantity": 1,
      "price": { ... }
    }
]

parameters.fulfillment

Order Parameter Object []

An object that holds a concise definition of a parameter, its value, and any associated errors.

Example:

[
  {
      "id": "PRM-1234-1234-1234-1234",
      "name": "Tennant Id",
      "externalId": "tennant_id",
      "value": "69b73824-ce76-4866-ad47-b615ae9d8998"
  }
]

parameters.ordering

Order Parameter Object []

An object that holds a concise definition of a parameter, its value, and any associated errors.

Example:

[
  {
      "id": "PRM-1234-1234-1234-0001",
      "name": "Microsoft Partner ID",
      "externalId": "msPartnerId",
      "constraints": {
          "readonly": false,
          "hidden": false,
          "required": true
      },
      "value": "123456",
      "error": {
          "id": "E001234",
          "message": "Unknown MS Partner ID"
      }
  }
]

subscriptions

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:

[
  { "id": "SUB-5374-9558-1697-7777" },
  { "id": "SUB-5374-9558-1697-8888" },
  { "id": "SUB-5374-9558-1697-9999" }
]  

price

Price

This represents the total price for an Order and is displayed to the various actors. Object is READONLY.

Please note not all fields are visible to all actors.

Example:

{  
  "PPxY": 150,  
  "PPxM": 12.50,  
  "SPxY": 165,  
  "SPxM": 13.75,  
  "markup": 0.10,  
  "margin": 0.11,  
  "defaultMarkup": 0.15,  
  "currency": "USD"
}

id

string

Human Friendly identifier of Subscription object.

Example: "SUB-2119-4550-8674-5962"

href

string

Relative reference to object on API (always /commerce/agreements/{id})

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:

{   
    "id": "AGR-2119-4550-8674-5962",
    "href": "/commerce/agreements/ACC-1234-1234",
    "name": "Microsoft Office 365 for My Company"
}

product

Product

Product reference

Example:

{
    "id": "PRD-1111-1111-1111",
    "href": "/catalog/products/PRD-1111-1111-1111",
    "name": "Microsoft Office 365 NCE",
    "icon": "/static/PRD-1111-1111-1111/logo.png"
}

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:

{
  "period": "1m",
  "commitment": "1y"
}

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:

{
  "PPxY": 150,
  "PPxM": 12.50,
  "SPxY": 165,
  "SPxM": 13.75,
  "markup": 0.10,
  "margin": 0.11,
  "defaultMarkup": 0.15,
  "currency": "USD"
}

lines

Lines[]

List of all product items (lines) purchasedi n scope of this subscription.

Example:

[
  { 
    "id": "ALI-1234-1234-1234-0001",
    "item": {
      "id": "ITM-1234-1234-1234-0021",
      "name": "Adobe Illustrator"
    },
    "quantity": 10,
    "price": { ... }
  },
  {
    "id": "ALI-1234-1234-1234-0002",
    "item": {
      "id": "ITM-4444-4444-4444-0031",
      "name": "Adobe Photoshop"
    },
    "quantity": 1,
    "price": { ... }
  }
]

parameters

object

An object that groups together separate lists of parameters. Only fulfillment parameters are available in this object.

Example:

{
    "fulfillment": [...]
}

parameters.fulfillment

Order Parameter Object

An object that holds a concise definition of a parameter, its value, and any associated errors.

Example:

{
    "name": "New Subscription",
    "value": "Super_value_UPDATED",
    "constraints": {
        "readonly": false,
        "hidden": true,
        "required": true,
        "unique": false
    }
}

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:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "terminated": { "at": "...", "by": { } }
}

externalIDs

ExternalIDsObject

Set of external IDs.

Example:

{
  "client": "12345678",
  "vendor": "ABC-2023-C07-dbeee0b302c0"
}