id

string

Product Identifier.

Example: "PRD-1234-1234"

href

string

Relative reference to product on API (always v1/products/{id})

Example: "/v1/products/PRD-1234-1234"

name

string

Product name

Example: "Microsoft 365 online services for commercial"

shortDescription

string

Short description of product.

Example: "Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently."

longDescription

string

Long description of product.

Example: "Microsoft 365 and Office 365 are cloud-based productivity suites that offer a range of applications and services to help businesses of all sizes work more efficiently. These plans combine the familiar Microsoft Office desktop suite with cloud-based versions of Microsoft's next-generation communications and collaboration services (including Office for the web, Microsoft Exchange Online, Microsoft Teams, and Microsoft SharePoint Online) to help users be productive from virtually anywhere through the Internet"

website

string

URL for Product website.

Example: "https://www.microsoft.com"

icon

string

Product logo (aka icon)

Example: "/static/PRD-1234-1234/logo.png"

externalIds

ExternalIds

Example:

{
  "operations": "op-322-322",
}

vendor

Reference to the vendor Account object.

Example:

{
    "id": "ACC-1234-1234",
    "href": "/accounts/accounts/ACC-1234-1234",
    "name": "Microsoft",
    "icon": "/static/ACC-1234-1234/account.png"
}

status

status

Possible values: Draft, Pending, Published, and Unpublished.

settings

ProductSettings

Activate item selection validation:

Used in the “Purchase wizard” to validate vendor-specific compatibility of selected items, before the order is submitted.

Activate validation of change orders in a draft state

Used to validate vendor-specific rules on a change order within the Purchase wizard (via existing agreement) and Subscription edit screen

Activate validation of product requests in a draft state

Used to perform vendor-specific validation on the product’s request form before form submission.

Activate validation of purchase orders in a draft state

Used to perform vendor-specific validation of purchase order within the “Purchase wizard”

Activate validation of purchase orders in a querying state

Used to perform vendor-specific validation when client is responding to a purchase order where vendor has requested additional information from the client.

Activate validation of termination order in a draft state

Used to perform vendor-specific validation when client initiates termination order on an agreement or subscription.

Example:

{
  "productOrdering": true,
  "productRequests": {
    "enabled": true,
    "title": "Contact us about Microsoft 365 Online Services",
    "label": "Contact us"
  },
  "itemSelection": false,
  "orderQueueChanges": false,
  "preValidation": {
    "purchaseOrderDraft": false,
    "purchaseOrderQuerying": false,
    "changeOrderDraft": false,
    "terminationOrder": false,
    "productRequest": false
  }
} 

statistics

ProductStatistics

Product statistics.

Example:

{
  "items": 110,
  "orders": 123,
  "agreements": 1,
  "subscriptions": 20
}

productOrdering

boolean

Displays “Buy” button on the product card, enabling clients to place an order for this product.

Example: "true"

itemSelection

boolean

Validates compatibility of selected product items within the purchase order, supporting order processing.

Example: "false"

orderQueueChanges

boolean

Enables notifications of changes in the order queue.

Example: "false"

productRequests

Settings for product requests page.

preValidation

Settings for pre validation phase during purchase.

enabled

boolean

Displays request button on the product card, enabling clients to request more information about a product.

Example: "true"

name

string

This will appear as the title on the request wizard.

Example: "Contact us about Microsoft 365 Online Services"

label

string

This will appear as the button label on the product listing card.

Example: "Contact us"

purchaseOrderDraft

boolean

Validates purchase order during the creation and before the order is submitted.

Example: "false"

purchaseOrderQuerying

boolean

Validates purchase orders when client is requested to provide more information to the vendor on that order.

Example: "false"

changeOrderDraft

boolean

Validates change order during the creation and before the order is submitted.

Example: "false"

terminationOrder

boolean

Validates termination orders during the creation and before the order is submitted.

Example: "false"

productRequest

boolean

Validates the product request form while client is filling in information and before the form is submitted.

Example: "false"

items

integer

Number of items assigned to the product.

Example: "1"

orders

integer

Number of orders placed with the product.

Example: "2"

agreements

integer

Number of agreements signed with the product.

Example: "4000"

subscriptions

integer

Number of existing subscriptions with the product.

Example: "2"

requests

integer

Number of requests related to the product.

Example: "100"

Draft

The product is being created by the vendor.

It is not yet available in the marketplace.

Pending

The vendor has submitted the product to SoftwareOne Operations for review and publishing to the marketplace.

Published

The product is available for buying through the marketplace.

Unpublished

The product is no longer available in the marketplace.

id

string

Platform generated ID.

Example: "PRD-1234-1234-1234"

href

string

Resource reference.

Example: "/v1/products/PRD-1234-1234-1234"

scope

string

Describes in which context parameter will be used.

Example: "Agreement"

phase

string

Described in which process it will be used.

Example: "Order"

type

string

Indicates which UI component will be used to capture information.

Example: "Email"

options

One of:

• AddressOptions

• CheckboxOptions

• SingleLineTextOptions

• MultiLineTextOptions

• ChoiceOptions

• AddressOptions

• ContactOptions

• SubdomainOptions

• HeadingOptions

• DropDownOptions

• EmailOptions

• DataObjectOptions

• DateOptions

Are specific to a selected type and allow customization of UI component.

Example:

{
    "label": "Client address",
    "hintText": "please add your email",
    "placeholderText": "someone@org.com",
    "defaultValue": "none"
}

constraints

ConstraintsObject

Used to specify characteristics of entire parameter, though it can have an impact of the validation of values too (i.e. turning on “Optional” will override any mandatory field within the UI components associated to the selected type.

group

Groups allow logical grouping of parameters, used by purchase wizard and represented as wizard step.

externalId

string

Used for programmatic processing, for example as a variable name within embedding templates or within a “connector” process.

Example: "EXT-1234-1234"

id

string

Platform

generated ID.

Example: "PGR-6790-8304-0001"

href

string

Relative reference to object on API (always /products/{product-id}/parameter-groups/{id}).

Example: "/products/PRD-6790-8304-0171/parameter-groups/PGR-6790-8304-0001"

name

string

Name of the group.

Example: "Parameters"

label

string

Label displayed in the wizard steps selector.

Example: "Create agreement"

description

string

Description of the group.

Example: "When creating a new agreement with SoftwareOne, you can establish a new Microsoft account or connect your existing account."

displayOrder

integer

Defines the display order.

Example: "100"

default

boolean

Marks the default item group.

Example: "true"

parameterCount

integer

The number of parameters in the group.

Example: "5"

product

Idle

The parameter has been created as part of the product definition.

It can be used to collect data as part of the order, fulfillment, or configuration phases.

Deleted

The parameter no longer exists.

It's no longer part of the product definition and can't be used to collect data as part of the order, fulfillment, or configuration phases.

Idle

The parameter group has been created as part of the product definition, which will be used as a step in the purchase wizard when a client orders the product.

Deleted

The parameter group no longer exists.

It's no longer part of the product definition and can't be used anymore.

id

string

Platform generated Id.

Example: "ITM-0690-0539-0001"

href

string

The resource URI of the Item.

Example: "/product-items/ITM-0690-0539-0001"

name

string

Name of the item.

Example: "Microsoft 365 Apps for Business"

description

string

Item description.

Example: "Best for businesses that need Office apps across devices and cloud file storage. For businesses with up to 300 employees."

externalIds

Example:

{
  "vendor": "ven-1233-3222",
  "operations": "op-322-322",
}

terms

Terms

Terms for the Items, as defined in Terms object.

Example:

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

quantityNotApplicable

boolean

Is quantity is not applicable or relevant to the product item being sold.

Example: "true"

status

Status of the item.

Example: "Draft"

parameters

Captures any additional information required for a product item and is defined by item configuration parameters.

Only item configuration parameters are available on this list.

Example:

{ 
  "id": "PRM-1234-1234-1234",
  "externalId": "SKU",
  "value": "65272478BB01A12"
}

group

Item group to wich item is assigned.

unit

UnitOfMeasure

Unit of measure assigned to item.

product

Product to which item is assigned.

audit

AuditObject

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

Example:

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

id

string

Identifier of parameter definition this value refers to.

Example: "PDF-1234-1234-1234"

externalId

string

Id of the parameter in external system.

Example: "SKU"

name

string

Parameter display name.

Example: "Stock keeping unit"

value

string

Value of the parameter.

Example: "65272478BB01A12"

vendor

string

A vendor identifier is item identifier recognizable by vendor, so when an order is placed they will easily understand which item is to be provisioned.

id

string

Platform generated ID.

Example: "IGR-6790-8304-0001"

href

string

Relative reference to object on API (always /products/{product-id}/item-groups/{id}).

Example: "/products/PRD-6790-8304/item-groups/IGR-6790-8304-0001"

name

string

Name of the group.

Example: "Items"

label

string

Label displayed in the wizard steps selector.

Example: "Select items"

description

string

Description of the group.

Example: "<p><span>Your purchase of Microsoft 365 Online Services comes with SoftwareOne’s best-in-class Digital Workplace Essentials service offering includes. </span></p><p><br></p><p><span>In addition to this offering, you can add SoftwareOne’s backup service to your purchase. For more information on this service, click </span><a href="www.google.pl" ><span >here</span></a><span>.</span></p>"

displayOrder

integer

Defines the display order of the group.

Example: "100"

default

boolean

Marks the default item group.

Example: "true"

multiple

boolean

Allows multiple selection of items.

Example: "false"

required

boolean

Requires selection of item in the group.

Example: "true"

itemCount

integer

The number of items in the group.

Example: "5"

product

Idle

The item group has been created as part of the product definition, which will be used as a step in the purchase wizard when the product is ordered.

Deleted

The item group no longer exists.

It is no longer part of the product definition and cannot be used anymore.

Draft

The item object is being created by the vendor.

The object is not visible to the clients in the marketplace.

Review

The vendor has submitted the item to SoftwareOne Operations for review and publishing.

SoftwareOne Operations will add the ERP item ID before publishing.

Published

The item object is available in the marketplace.

Unpublished

The item object is not available in the marketplace.

Deleted

The item object no longer exists.

It's no longer part of the product definition and can't be used anymore.

Draft

The documentation object is being created by the vendor.

The object is not visible to the clients yet in the marketplace.

Pending

The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing.

Published

The documentation object is visible in the marketplace.

Unpublished

The documentation object is not visible in the marketplace.

Deleted

The document object no longer exists.

It's no longer part of the product definition and can't be used.

id

string

href

string

name

string

The name of the document object.

Example: "Guide to establishing a reseller relationship"

description

string

The description of the document object.

Example: "Learn what happens when you establish a reseller relationship with SoftwareOne"

type

string

The type of the document object/

url

string

The URI to access document object.

Example: " Polish"

language.name

string

Example: "pl-pl"

language.code

string

Example: "Guide to establishing a reseller relationship"

status

string

Draft, Published, or Deleted.

product

Example:

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

audit

Audit Object

Example:

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

id

string

href

string

name

string

The name of the media object.

Example: "Office 365 Product Image"

description

string

The description of the media object.

Example: "An image of Office 365 which is available to purchase within the Microsoft 365 Online Services product"

type

string

The type of the media object.

url

string

The URI to access media object.

Example: "https://address.to.media.file.pl/abcde.png"

displayOrder

integer

Media object order on list.

Example: "100"

status

string

Draft or Published.

product

Product Object

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

audit

Audit Object

Example:

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

Draft

The documentation object is being created by the vendor.

It is not visible to clients yet in the marketplace.

Pending

The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing.

Published

The media object is visible in the marketplace.

Unpublished

The media object is not visible in the marketplace.

Deleted

The media object no longer exists.

It's no longer part of the product definition and can't be used.

Draft

The terms object is being created by the vendor.

It is not visible to the clients in the marketplace.

Pending

The vendor has submitted the documentation object to SoftwareOne Operations for review and publishing.

Published

The terms object is visible in the marketplace.

Unpublished

The terms object is not visible in the marketplace.

Deleted

The document object no longer exists.

It is no longer part of the product definition and can't be used.

id

string

Terms identifier.

Example: "TCS-1234-1234-1234"

href

string

Relative reference to terms to product (/products/{productid}/terms-and-conditions/{termsAndConditionsId}

Example:

/products/PRD-6822-9898-4256/terms-and-conditions/TCS-3159-1891-0980-8679

name

string

Terms name

Example: "Terms of Service"

description

string

Terms description

Example: "Terms of Service description"

displayOrder

int

Terms display order

Example: "10"

status

Terms status.

Example: "draft"

product

Product to which item is assigned.

audit

AuditObject

Audit events: created, updated.

Example:

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

id

string

Terms Variant identifier.

Example: "TCS-1234-1234-1234-1234"

href

string

Relative reference to the terms item to terms to product (always products/{productId}/terms/{tcid}/terms-item/{termsAndConditionsItemId})

Example:

/products/PRD-1234-1234/terms/tcs-1234-1234-1234/terms-item/tcs-1234-1234-1234-1234

type

Online or File

Terms Item type.

Example: "Online"

name

string

Terms Variant name.

Example: "TCS-1234-1234-1234-1234"

description

string

Terms Variant description.

Example: "Terms of Service description in English"

assetUrl

string

URL of the terms item uploaded document or or online document/resource.

Example: "https://www.test.com/terms-of-service"

languageCode

string

Terms Item 2-digit language code.

Example: "en"

status

status

Terms Item status: Draft

Pending, Published, Unpublished.

Example: "Draft"

termsAndConditions

Terms and conditions

Terms to which item is assigned.

audit

AuditObject

Audit events: created, updated.

Example:

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

id

string

Template ID.

Example: "TPL-1234-5678"

href

string

Relative reference to object on API (always products/{id}/templates/{id})

Example: "v1/products/PRD-1234-1234/templates/TPL-1234-5678-0001"

name

string

Template name

Example: "Thank you for your interest"

type

string

Example: "RequestProcessing"

content

string

Content for the template.

Example:

<p>We are delighted that you have contacted us at SoftwareOne. Your interest in Microsoft 365 Online Services product is greatly valued, and we are here to provide all the support you need. Our dedicated team is actively working on your query, and we are committed to responding within 24 hours. \n Thank you!!!<p>

default

boolean

• Each product will have 4 defaults automatically generated upon product creation (against each status)

• Each template automatically created will have a default system message client account will need to update these

• Default cannot be deleted

• Non default can be deleted

Example: "true"

product

Example:

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

audit

Audit Object

Idle

The template object has been created as part of the product definition.

The object will be used in the scope of orders, agreements, and notification messages.

Deleted

The template no longer exists.

It's no longer part of the product definition and can't be used anymore.

Idle

The pricelist object has been created as part of the product definition.

It will be used to sell the items against a listing in the scope of authorization.

Deleted

The price list no longer exists.

It's no longer part of the product definition and can't be used anymore.

id

string

The business identifier of the Price List.

Example: "PRC-1234-5678-9012"

href

string

The resource URI of the Price List.

Example: "/v1/price-lists/PRC-1234-5678-9012"

currency

string

Currency as ISO code.

Example: "EUR"

precision

integer

Precision of the Price List as number of decimal places.

Example: "3"

notes

string

Any user notes about the Price List.

Example: "This is the primary Price List for the EU region"

externalIds

ExternalIds

Example:

{
  "vendor": "op-322-322",
}

statistics

PriceListStatistics

System calculated metrics about the Price List

product

Product

The Product that the Price List belongs to.

vendor

Account

The Vendor that the Price List belongs to. The field is visible only for OPS

audit

Audit

Audit events for the object.

Example:

{
  "created": { 
    "at": "2023-12-14T17:28:57Z", 
    "by": {
      "id": "UR-1234-1234-1234",
      "name": "John Smith",
      "icon": "/static/users/UR-1234-1234-1234.icon.svg"
    }
}

sellers

integer

The number of Sellers that are using this Price List.

Example: "10"

listings

integer

The number of Listings that are using this Price List.

Example: "12"

priceListitems

integer

The total number of pice list Items on the Price List.

Example: "23"

purchasePriceItems

integer

The number of Items with a populated purchase price.

Example: "10"

purchasePriceCompleteness

decimal

The percentage of Items with a populated purchase price.

Example: "0.4347826"

Draft

Private

For sale