New release coming soon. Check out the latest release notes to preview upcoming features:
Release Notes
Marketplace Platform
Sign InJoin
  • Home
  • Marketplace Platform
    • Platform Overview
    • Getting Started
      • Key Concepts
      • Platform Interface
        • Manage Notification Preferences
        • View Object Spotlight
        • Customize the Data Grid
        • View Information Cards
        • Switch Accounts
        • Manage Your Profile
        • Mark Favorite Pages
      • Marketplace for Clients
        • How to Buy Products in the Marketplace
        • How to Filter Your Orders
        • How to Manage Your Subscriptions
        • How to Change License Quantity
        • How to Add Items to Your Agreement
        • How to Manage Your Account Settings
        • How to Split Billing Across Buyers
        • How to Invite Users to Your Account
      • Marketplace for Partners
        • What is Partners Management?
        • How to Configure Licensees For Resale
        • How to Order Products for Resale
  • MODULES & FEATURES
    • Inventory
      • Invoices
      • License Agreements
      • Software Downloads
      • Orders
      • Quotes
        • Create and Manage Quotes
      • Software Assets
        • Enable or Disable Software Assets
        • View Software Assets
        • Export Software Assets
        • Import Software Assets
    • Marketplace
      • Agreements
        • Agreement States
        • Terminate Agreement
        • Rename Agreement
        • Update Additional Client ID
        • View and Download Attachments
      • Billing
        • Understand Your Billing Documents
        • Statements
          • Download Statements
        • Split Billing
          • Configure Buyers for Split Billing
          • Set Up Split Billing Allocation
          • Edit Split Billing
          • Split Billing for Change Orders
          • Review Split Billing Configuration
          • Specify PO Numbers for Split Billing
      • Certificates
        • Certificate States
        • Add Certificate
        • Request Certificate
        • Rename Certificate
      • Enrollments
        • Enrollment States
        • Manage Querying Enrollments
        • Renew Your Enrollment
      • Orders
        • Order States
        • Save Orders for Later
        • Delete Orders
        • Submit Your Saved Orders
        • Manage Order Notes
        • Change Your Order's Status to Processing
        • Send Order Reminder Email
      • Products
      • Programs
      • Requests
        • Request States
        • Create New Requests
        • Add Messages to Your Request
        • Add or Remove Attachments
        • Change Your Request's Status to Processing
      • Subscriptions
        • Subscription States
        • Buy Subscriptions
        • Edit Subscription Name
        • Edit Subscription Client ID
        • Terminate Subscriptions
        • Manage Automatic Renewals
    • Other Tools
      • Collaboration Site
      • Dashboards
      • Reports
        • Consumption Alerts
        • Cloud Journey Report
        • Customized Spend Reports
        • Microsoft Services Provider License Agreement (SPLA) Report
        • Office365 Spend Report
        • Spend Reports - Consumption Overview
        • ServiceNow Asset Report
        • USU License Agreement Report
        • Reservation Monitoring - Cloud Reserved Instances
    • Procurement
      • Buy Products and Services
      • Procurement Workbench
        • View and Manage Software Transactions
      • Enterprise Agreements
        • Enterprise Agreement TrueUp
      • Purchase Approval Setup
        • Create Approval Groups
        • Create Approval Workflows
        • Delete Workflow Rules
      • Special Quotes
      • Service Provider Dashboard
    • Settings
      • Account
        • Update Account Details
      • API Tokens
        • Token States
        • Create API Token
        • Edit API Token
        • Copy API Token
        • Delete API Token
        • Enable or Disable API Token
      • Audit Trail
      • Buyers
        • Edit Buyers
        • Enable or Disable Buyers
      • Groups
        • Group States
        • Create New Group
        • Edit Group
        • Delete Group
        • Restrict Groups to Certain Buyers
      • Licensees
        • Licensee States
        • Create Licensee
        • Edit Licensee
        • Enable or Disable Licensee
      • Notifications
        • Notification States
        • Configure Recipients
        • Enable or Disable Categories
        • View Notification Messages
      • Sellers
      • Users
        • User States
        • Respond to Invitations
        • Add New Users
        • Edit Users
        • Remove Users
        • Manage User Invitations
  • EXTENSIONS
    • Adobe VIP Marketplace
      • Migrate from Adobe VIP
      • Downsize and Termination Policies
      • Common Error Messages
      • Tutorials
        • Order Adobe Subscriptions
        • Order New Adobe Items
        • Rename Adobe Subscription
        • Downsize Adobe Subscription
        • Upsize Adobe Subscription
        • Terminate Adobe Subscription
        • Terminate All Adobe Subscriptions
      • Webinars and Videos
      • FAQs
        • How do I activate my VIP Marketplace agreement?
        • What happens if I terminate my Adobe subscription?
      • Release Notes
      • Terms and Conditions
    • Cloud Tools
      • 365Simple
      • AzureSimple
      • Budgets
        • Create Reporting Period
        • Create Custom Group Budgets
        • Create Per-Provider Budgets
        • View Budgets
        • Request to Create or Update Budgets
        • Edit Budget Utilization Alerts
      • Chargebacks
        • About Chargebacks
      • Cloud Cost Optimization
      • Cloud Tenant Setup
        • Azure Onboarding
          • Activate an Azure EA or MPSA Account
          • Add an Azure MCA Account
          • Integrate Your Microsoft Tenant Manually
          • Complete Your Microsoft 365 or Microsoft Azure Activation
          • Assign Reader and Tag Contributor Roles (single subscription)
          • Assign Reader and Tag Contributor Roles (multiple subscriptions)
          • Migrate to Azure Cost Management APIs
          • Assign Azure Subscription Owner Rights
      • Custom Groups
        • Create Custom Groups
      • Pricelist Center
        • View and Add Prices
      • Recommendations
        • View Recommendations
        • Manage Recommendations
        • Azure Recommendations
        • AWS Recommendations
        • Office 365 Recommendations
      • Simple for AWS
      • Tags and Resources
      • Utilization
      • Release Notes
    • FinOps for Cloud
    • ITAM Tools
      • Renewal Manager
    • Microsoft CSP
      • Azure Lighthouse
        • Assign Subscription Owner Role
        • Complete Azure Lighthouse Onboarding
      • Granular Delegated Admin Privileges
        • Role Assignment and GDAP Configuration
        • Accept a GDAP Relationship Request
        • GDAP and Partner Relationship Request Considerations
      • Microsoft NCE
        • About Subscription Coterminosity
        • Coterming Subscriptions
        • Subscription End Date Errors
      • Microsoft GCC
      • Perpetual Software
        • About Perpetual Software Orders
        • Manage Perpetual Software Orders
      • Software Subscriptions
        • Manage Software Subscriptions
      • Renewal Management
      • Tutorials and Videos
        • Microsoft 365
          • Order Microsoft 365 Subscription For New Tenant
          • Order Microsoft 365 Subscription For Existing Tenant
          • Buy More Licenses for Microsoft 365 Subscription
          • Add New Products to Your CSP Agreement
          • Terminate All Subscriptions in Your Agreement
          • Terminate a Single Subscription
        • Microsoft Azure
          • Order Azure Subscription For New Tenant
          • Order Azure Subscription For Existing Tenant
          • Order Additional Microsoft Azure Subscriptions
        • Perpetual Software
          • Buy Perpetual Software Licenses
          • Order Additional Perpetual Software Licenses
      • FAQs
        • My order contains Azure reservations and savings plan items
        • What is offer attestation?
        • How do I establish a partner relationship with SoftwareOne?
        • How can I reduce my subscription quantities?
        • How do I troubleshoot Lighthouse activation errors?
        • What happens if I cancel my Microsoft subscription?
      • Release Notes
  • Developer Resources
    • REST API
      • Resource Query Language
      • Errors Handling
      • OpenAPI Specification
      • Accounts API
        • Account
          • List Accounts
          • Create Account
          • Enable Account
          • Disable Account
          • Activate Account
          • Get Account
          • Update Account
          • Validate Account
          • Get Account Icon
        • Buyer
          • List Buyers
          • Create Buyer
          • Enable Buyer
          • Disable Buyer
          • Get Buyer
          • Update Buyer
          • Delete Buyer
          • Validate Buyer
        • Seller
          • List Sellers
          • Get Seller
          • Create Seller
          • Update Seller
          • Activate Seller
          • Deactivate Seller
          • Disable Seller
          • Delete Seller
        • Licensee
          • List Licensees
          • Get Licensee
          • Create Licensee
          • Update Licensee
          • Delete Licensee
          • Enable Licensee
          • Disable Licensee
        • Module
          • List Modules
        • Users
          • List Users
          • Get User
          • Set User Password
          • Update User
          • Unblock User
          • Block User
        • User Groups
          • List User Groups
          • Get User Group
          • Create User Group
          • Update User Group
          • Delete User Group
        • Account User
          • List Account Users
          • Get Account User
          • Create Account User
          • Assign User to a Group
          • Update User to Group Assignment
          • Remove User
          • Accept User Invitation
          • Resend User Invitation
          • Send New Invitation
          • Delete Account User
        • API Tokens
          • List Tokens
          • Create Token
          • Get Token
          • Update Token
          • Delete Token
          • Enable Token
          • Disable Token
      • Billing API
        • Journal
          • List Journals
          • Create Journal
          • Get Journal
          • Delete Journal
          • Upload Journal Charges
          • Submit Journal
          • Regenerate Journal
          • Inquire Journal
          • Accept Journal
          • Get Sellers for a Journal
        • Journal Attachment
          • List Journal Attachements
          • Create Journal Attachment
          • Get Journal Attachment
          • Delete Journal Attachment
        • Ledger
          • List Ledgers
          • Update Ledger
          • Get Ledger
          • Recalculate Ledger
          • Accept Ledger
        • Statement
          • List Statements
          • Get Statement
          • Retry Failed Statement
          • Recalculate Statement
          • Cancel Statement
        • Invoice
          • List Invoices
          • Get Invoice
          • Update Invoice
        • Custom Ledger Object
          • List Custom Ledgers
          • Get Custom Ledger
          • Create Custom Ledger
          • Update Custom Ledger
          • Delete Custom Ledger
          • Upload Charges for Custom Ledger
          • Accept Custom Ledger
      • Audit API
        • Audit Record
          • List Audit Records
          • Create Audit Record
          • Get Audit Records
        • Audit Event Type
          • List Audit Event Types
      • Commerce API
        • Agreements
          • List Agreements
          • Get Agreement
          • Create Agreement
          • Update Agreement
          • Render Agreement Template
        • Agreements Attachments
          • List Agreement Attachments
          • Get Agreement Attachment
          • Create Agreement Attachment
          • Delete Agreement Attachment
        • Requests
          • List Requests
          • Create Request
          • Get Request
          • Update Request
          • Validate Request
          • Process Request
          • Query Request
          • Complete Request
        • Requests Messages
          • List Request Messages
          • Get Request Message
          • Create Request Message
        • Requests Attachments
          • List Request Attachments
          • Get Request Attachment
          • Create Request Attachment
          • Delete Request Attachment
        • Subscriptions
          • List Subscriptions
          • Get Subscription
        • Orders
          • List Orders
          • Get Order
          • Update Order
          • Create New Order
          • Validate Order
          • Process Order
          • Query Order
          • Complete Order
          • Fail Order
          • Delete Order
          • Render Order Template
        • Order Subscription
          • List Subscriptions
          • Get Order Subscription
          • Create Order Subscription
          • Update Order Subscription
          • Remove Order Subscription
      • Catalog API
        • Product
          • Product States
          • Create Product
          • Get Product
          • List Products
          • Update Product
          • Delete Product
          • Mark Product for Review
          • Publish Product
          • Unpublish Product
          • Update Product Settings
        • Parameter
          • Parameter States
          • Create Product Parameter
          • List Product Parameters
          • Update Product Parameter
          • Get Product Parameter
          • Delete Product Parameter
        • Parameter Group
          • Parameter Group States
          • Create Parameter Group
          • List Parameter Groups
          • Get Parameter Group
          • Update Parameter Group
          • Delete Parameter Group
        • Items
          • Item States
          • Create Item
          • List Items
          • Update Item
          • Get Item
          • Delete Item
          • Mark Item For Review
          • Publish Item
          • Unpublish Item
        • Documentation
          • Documentation States
          • Create Document
          • Get Document
          • List Documents
          • Update Document
          • Delete Document
          • Publish Document
          • Mark Document For Review
          • Unpublish Document
        • Media
          • Media States
          • Create Product Media
          • Get Product Media
          • List Product Media
          • Update Media
          • Publish Media
          • Unpublish Media
          • Mark Media For Review
          • Delete Media
        • Terms & Conditions
          • Terms & Conditions States
          • Create Terms
          • List Terms
          • Get Terms
          • Update Terms
          • Mark Terms For Review
          • Publish Terms
          • Unpublish Terms
        • Variants
          • Create Variant
          • List Variants
          • Delete Variant
          • Get Variant for Terms
          • Mark Variant for Review
          • Publish Variant
          • Unpublish Variant
        • Templates
          • Templates States
          • Create Template
          • List Templates
          • Update Template
          • Get Template
          • Delete Template
        • Pricelists
          • Pricelist States
          • Pricelist Item States
          • Create Pricelist
          • List Pricelists
          • Get Pricelist
          • Update Pricelist
          • List Pricelist Items
          • Get Pricelist Item
          • Update Pricelist Item
      • Spotlight Objects API
        • Spotlight Object
          • Spotlight TopItem
          • List Spotlighted Objects
          • Invalidate Cache
          • Invalidate All Cache
        • Spotlight Query
          • List Spotlight Queries
          • Get Spotlight Query
          • Update Spotlight Query
    • Open Source
      • GitHub Projects
      • Code of Conduct
      • Contributor License Agreement
  • Design System
  • Help and Support
    • Contact Support
    • Status Page
    • YouTube Channel
    • Release Notes
      • Release Notes v4
      • Release Notes v3
      • Release Notes v2
      • Release Notes v1
    • Planned Maintenance
    • Platform FAQs
      • I have questions about billing
      • How do you handle purchase order numbers in subscription-based models?
      • What happens to an agreement when subscriptions expire or are terminated?
      • How do I change the language in my account?
      • How do I update my password?
      • Which browsers do you support?
      • I'm unable to view the Reserved Instance data
      • How do I set up SSO?
      • How do I configure conditional access policies?
      • How do I resolve AWS recommendation errors?
      • How does the platform connect to my Azure tenant?
      • I have questions about access tokens and consent
      • Why isn't my Azure billing data up to date?
      • How does the platform access my Microsoft tenant under CSP?
      • How do I connect the Microsoft tenant for data collection?
      • My 365 Analytics report is empty
      • How to create service accounts for 365 Analytics reporting
      • What data do you collect for 365 Analytics?
      • What is 365 Analytics delegation and policy control?
    • Terms of Use
Powered by GitBook
LogoLogo

Company

  • About SoftwareOne
  • Careers
  • Media Releases

Policies

  • Codes of Conduct
  • Privacy Statement
  • Terms & Conditions

Resources

  • Status
  • Partner Program

© 2025 SoftwareOne. All rights reserved.

On this page

Was this helpful?

Export as PDF
  1. Developer Resources
  2. REST API
  3. Commerce API

Orders

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.

The Order object contains the following properties:

Field
Type
Description

id

string

Primary identifier for the order.

Example: ORD-5542-1187-3130-0991

href

string

Relative reference to the object in the API.

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

type

string

The type of order. Specified when the order is created and cannot be updated.

Example: Purchase

status

string

Status of the order.

Example: Processing

externalIds

ExternalIds

External IDs for either client/vendor/distributor.

Example:

notes

string

Contains initial customer notes added by the buyer during the purchase process. Buyers can edit and add notes at any time for all order statuses.

Example: Order of 2 subs for 2 ppl from the accounting dept.

statusNotes

Message Object

Notes added during status change by the vendor or vendor extensions to indicate the reason for order failure or status change.

Example:

error

Message Object

Standard error object. Means some error appeared on the parameters validation, which can include markup.

Used to indicate a validation error by the vendor or vendor extension during order validation.

Example:

agreement

Agreement

The agreement represents an instance of a relationship between the seller, buyer, and the licensee.

It may refer to one-time purchases or/and set of subscriptions.

Example:

authorization

Authorization

Reference to the Authorization object which was used for the order.

Example:

listing

Listing

Reference to the listing that was used for the order.

Example:

template

Template

Reference to the Template object.

Example:

assignee

User

Reference to the User object.

Example:

audit

AuditObject

Reference to the Audit object.

Example:

lines

Line

Order lines contain the information about the specific item the buyer is purchasing/updating.

Example:

parameters.fulfillment

Order Parameter Object

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:

subscriptions

Subscription

List of subscription references for subscriptions to be added or updated by the order.

Example:

price

Price

Represents the total price for the order and is displayed to the various actors. The object is READONLY.

Not all fields are visible to all actors.

Example:

Example

{
  "id": "ORD-6869-4529-8975-9005",
  "agreement": {
    "id": "AGR-2119-4550-8674-5962",
    "name": "Microsoft Office 365 NCE E1"
  },
  "type": "Purchase",
  "status": "Processing",
  "statusNotes": {
    "id": "ERR-123-123",
    "message": "Vendor API is not responding. Try later"
  },
  "template": {
    "id": "TPL-1234-4444",
    "name": "Activation in Progress"
  },
  "assignee": {
    "id": "USR-1234-1234-1234",
    "name": "John Smith",
    "icon": "/static/users/USR-1234-1234-1234.icon.svg"
  },
  "lines": [
      {  // Upsize
        "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" }
      },
      {   // New purchase
        "id": "ALI-1234-1234-1234-0002",
        "item": {
          "id": "ITM-4444-4444-4444-0031",
          "name": "Adobe Photoshop"
        },
        "quantity": 1,
        "price": { ... }
      }
  ],
  "notes": "Order for accounting team",
  "parameters": {
    "fulfillment": [
      {
        "id": "PRM-1234-1234-1234-1234",
        "name": "Tennant Id",
        "externalId": "tennant_id",
        "value": "69b73824-ce76-4866-ad47-b615ae9d8998"
      }
    ],
    "ordering": [
      {
        "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"
        }
      }
    ]
  },
  "externalIDs": {
    "client": "abc-123",
    "operations": "SO-1234-1234-1111"
  },
  "audit": {
    "created": { "at": "...", "by": { } },
    "updated": { "at": "...", "by": { } },
    "activated": { "at": "...", "by": { } },
    "terminated": { "at": "...", "by": { } }
  }
}
PreviousGet SubscriptionNextList Orders

Last updated 2 days ago

Was this helpful?

{
  "client": "abc-123",
  "operations": "SO-1234-1234-1111"
}
{
    "id": "E001234",
    "message": "Adobe cannot provision your subscription"
}
{
    "id": "E001234",
    "message": "Order has incompatible items - education and government"
}
{
    "id": "AGR-2119-4550-8674-5962",
    "name": "Microsoft Office 365 NCE E1",
    "icon": null
}
{
    "id": "AUT-1234-4567",
    "name": "Salesforce Enterprise License"
}
{
    "id": "LST-1234-1234"
}
{
    "id": "TPL-1234-4444",
    "name": "Succesful Activation"
}
{
    "id": "TPL-1234-4444",
    "name": "Succesful Activation"
}
{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "terminated": { "at": "...", "by": { } }
}
[
   {
      "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": { ... }
    }
]
[
  {
      "id": "PRM-1234-1234-1234-1234",
      "name": "Tennant Id",
      "externalId": "tenant_id",
      "value": "69b73824-ce76-4866-ad47-b615ae9d8998"
  }
]
[
  {
      "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"
      }
  }
]
[
  { "id": "SUB-5374-9558-1697-7777" },
  { "id": "SUB-5374-9558-1697-8888" },
  { "id": "SUB-5374-9558-1697-9999" }
]  
{  
  "PPxY": 150,  
  "PPxM": 12.50,  
  "SPxY": 165,  
  "SPxM": 13.75,  
  "markup": 0.10,  
  "margin": 0.11,  
  "defaultMarkup": 0.15,  
  "currency": "USD"
}