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

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

See Item States.

Status of the item.

Example: "Draft"

parameters

ParameterValue

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

ItemGroup

Item group to wich item is assigned.

unit

UnitOfMeasure

Unit of measure assigned to item.

product

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.

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.

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

ParameterGroup

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"

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.

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

Product

Reference to Product object.

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

See Terms & Conditions States

Terms status.

Example: "draft"

product

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

Product

Example:

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

audit

Audit Object