Loading...
Loading...
Loading...
The following diagram shows the possible states an item object may have in the Marketplace Platform and the transition between these states:
| State | Definition |
|---|---|
The Item object represents a “product item” as a transactable element of a product that, for example, in a created order, is represented as a “line item” of that order.
| Field | Type | Description |
|---|---|---|
The parameter object contains the value of the given parameter along with additional information like constraints.
ExternalIds contain any external identifier
| Field | Parameter | Description |
|---|---|---|
| Field | Type | Description |
|---|---|---|
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:
terms
Terms
Terms for the Items, as defined in Terms object.
Example:
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
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:
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:
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.