Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create a new product.
The following diagram shows the possible states a product object can have in the Marketplace Platform and the transition between these states:
The product object represents a collection of items and their relevant parameters curated into a cohesive group for business purposes. Defined by vendors, products are accessible through listings, providing a structured framework for transactional activities.
State | Definition |
---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
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
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:
vendor
Reference to the vendor Account object.
Example:
status
status
Possible values: Draft, Pending, Published, and Unpublished.
See Product States.
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:
statistics
ProductStatistics
Product statistics.
Example:
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.
Example: ProductRequestSettings
preValidation
Settings for pre validation phase during purchase.
Example: PreValidationSettings
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"
Unpublish a variant for a terms.
Create a variant for terms.
Get a list of all variants for terms.
Delete a variant for terms.
Mark a variant for terms for review.
Publish a variant for terms.
Get a single product by ID.
Get a variant for a terms
Get a list of products.
Update some properties of a product.
Delete a product.
Mark a product for review by the SoftwareOne Operations team.
Publish a product.
Unpublish a product.
Update a product’s setting.
Create a product parameter.
Get a list of parameters for a product.
The following diagram shows the possible states a parameter may have in the Marketplace Platform and the transition between these states:
Update a product parameter definition.
Get a product parameter definition.
Delete a product parameter definition.
Creates a new parameter group for given product in the catalog
The following diagram shows the possible states a group object may have in the Marketplace Platform and the transition between these states:
Lists all parameter groups for a given product based on filter criteria.
Gets a parameter group by id for a given product.
Updates a parameter group for a given product.
Deletes a parameter group from a given product.
The following diagram shows the possible states an item object may have in the Marketplace Platform and the transition between these states:
The following diagram shows the possible states a group object may have in the Marketplace Platform and the transition between these states:
The following diagram shows the possible states for the documentation object in the Marketplace Platform and the transition between these states:
Create a new document in catalog management.
Gets a document by id.
Lists all documents based on filter criteria.
Update document.
Vendor removes a document.
Publish a document.
Unpublish a document.
The following diagram shows the possible states for the media object in the Marketplace Platform and the transition between these states:
Create new media for a product.
Get an item of media for a product.
Get a list of media for a product.
Update the media for a product.
Unpublish an item of media for a product.
Mark an item of media for a product for review.
Delete an item of media for a product.
The following diagram shows the possible states for the terms and conditions object in the Marketplace Platform and the transition between these states:
Create terms for a product.
Mark the terms for a product for review.
Publish the terms for a product.
The following diagram shows the possible states for the templates object in the Marketplace Platform and the transition between these states:
Create a template for a product.
Get a list of templates for a product.
Update a template for a product.
Get a template for a product.
Delete a template for a product.
The following diagram shows the possible states for the pricelist object in the Marketplace Platform and the transition between these states:
Creates a price list.
List of price lists.
Gets a price list.
Updates a price list.
Gets a price item within a price list.
Updates a price item within a price list.
Publish an item of media for a product.
Get a list of all terms for a product.
Delete terms for a product.
Update the terms for a product.
Unpublish the terms for a product.
The following diagram shows the possible states for the pricelist item object in the Marketplace Platform and the transition between these states:
The Pricelist
object includes key pricing details such as sales and purchase prices, enabling vendors and operations to effectively manage and apply different price points for product items. This tool is essential for aligning pricing strategies with market and internal financial objectives.
The Terms
object represents terms as a collection of uploaded PDF or DOCX documents or links to externally hosted documents as an element of a product.
The TermsVariant
object represents terms variant as an uploaded PDF or DOCX document or a link to an externally hosted document as an element of terms for a product.
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.
The parameter object contains the value of the given parameter along with additional information like constraints.
ExternalIds contain any external identifier
Field | Type | Description |
---|---|---|
State | Definition |
---|---|
Field | Type | Description |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
State | Definition |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Type | Description |
---|
Field | Parameter | Description |
---|
Field | Type | Description |
---|
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:
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"
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. |
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. |
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 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. |
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. |
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. |
Draft |
Private |
For sale |
| integer | The number of Sellers that are using this Price List. Example: "10" |
| integer | The number of Listings that are using this Price List. Example: "12" |
| integer | The total number of pice list Items on the Price List. Example: "23" |
| integer | The number of Items with a populated purchase price. Example: "10" |
| decimal | The percentage of Items with a populated purchase price. Example: "0.4347826" |
| string | Identifier of parameter definition this value refers to. Example: "PDF-1234-1234-1234" |
| string | Id of the parameter in external system. Example: "SKU" |
| string | Parameter display name. Example: "Stock keeping unit" |
| string | Value of the parameter. Example: "65272478BB01A12" |
| 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. |
| string | Platform generated ID. Example: "PGR-6790-8304-0001" |
| string | Relative reference to object on API (always Example: "/products/PRD-6790-8304-0171/parameter-groups/PGR-6790-8304-0001" |
| string | Name of the group. Example: "Parameters" |
| string | Label displayed in the wizard steps selector. Example: "Create agreement" |
| 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." |
| integer | Defines the display order. Example: "100" |
| boolean | Marks the default item group. Example: "true" |
| integer | The number of parameters in the group. Example: "5" |
|
| string |
|
| string |
|
| string | The name of the document object. Example: "Guide to establishing a reseller relationship" |
| string | The description of the document object. Example: "Learn what happens when you establish a reseller relationship with SoftwareOne" |
| string | The type of the document object/ |
| string | The URI to access document object. Example: " Polish" |
| string | Example: "pl-pl" |
| string | Example: "Guide to establishing a reseller relationship" |
| string | Draft, Published, or Deleted. |
| Example: |
| Audit Object | Example: |
| string | Template ID. Example: "TPL-1234-5678" |
| string | Relative reference to object on API (always Example: "v1/products/PRD-1234-1234/templates/TPL-1234-5678-0001" |
| string | Template name Example: "Thank you for your interest" |
| string | Example: "RequestProcessing" |
| string | Content for the template. Example: |
| boolean |
Example: "true" |
|
Example: |
| Audit Object |
|
| string | The business identifier of the Price List. Example: "PRC-1234-5678-9012" |
| string | The resource URI of the Price List. Example: "/v1/price-lists/PRC-1234-5678-9012" |
| string | Currency as ISO code. Example: "EUR" |
| integer | Precision of the Price List as number of decimal places. Example: "3" |
| string | Any user notes about the Price List. Example: "This is the primary Price List for the EU region" |
| ExternalIds | Example: |
| PriceListStatistics | System calculated metrics about the Price List |
| Product | The Product that the Price List belongs to. |
| Account | The Vendor that the Price List belongs to. The field is visible only for OPS |
| Audit | Audit events for the object. Example: |
| string | Platform generated ID. Example: "IGR-6790-8304-0001" |
| string | Relative reference to object on API (always Example: "/products/PRD-6790-8304/item-groups/IGR-6790-8304-0001" |
| string | Name of the group. Example: "Items" |
| string | Label displayed in the wizard steps selector. Example: "Select items" |
| 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>" |
| integer | Defines the display order of the group. Example: "100" |
| boolean | Marks the default item group. Example: "true" |
| boolean | Allows multiple selection of items. Example: "false" |
| boolean | Requires selection of item in the group. Example: "true" |
| integer | The number of items in the group. Example: "5" |
|
| string | Terms identifier. Example: "TCS-1234-1234-1234" |
| string | Relative reference to terms to product (/products/{productid}/terms-and-conditions/{termsAndConditionsId} Example: |
| string | Terms name Example: "Terms of Service" |
| string | Terms description Example: "Terms of Service description" |
| int | Terms display order Example: "10" |
| Terms status. Example: "draft" |
| Product to which item is assigned. |
| AuditObject | Audit events: created, updated. Example: |
| string | Terms Variant identifier. Example: "TCS-1234-1234-1234-1234" |
| string | Relative reference to the terms item to terms to product (always products/{productId}/terms/{tcid}/terms-item/{termsAndConditionsItemId}) Example: |
| Online or File | Terms Item type. Example: "Online" |
| string | Terms Variant name. Example: "TCS-1234-1234-1234-1234" |
| string | Terms Variant description. Example: "Terms of Service description in English" |
| string | URL of the terms item uploaded document or or online document/resource. Example: "https://www.test.com/terms-of-service" |
| string | Terms Item 2-digit language code. Example: "en" |
| status | Terms Item status: Draft Pending, Published, Unpublished. Example: "Draft" |
| Terms and conditions | Terms to which item is assigned. |
| AuditObject | Audit events: created, updated. Example: |
| string | Platform generated Id. Example: "ITM-0690-0539-0001" |
| string | The resource URI of the Item. Example: "/product-items/ITM-0690-0539-0001" |
| string | Name of the item. Example: "Microsoft 365 Apps for Business" |
| string | Item description. Example: "Best for businesses that need Office apps across devices and cloud file storage. For businesses with up to 300 employees." |
| Example: |
| Terms | Terms for the Items, as defined in Terms object. Example: |
| boolean | Is quantity is not applicable or relevant to the product item being sold. Example: "true" |
| Status of the item. Example: "Draft" |
| 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: |
| Item group to wich item is assigned. |
| UnitOfMeasure | Unit of measure assigned to item. |
| Product to which item is assigned. |
| AuditObject | Audit object with possible entries: created, updated, activated, terminated, according to lifecycle of the object. Possible audit events: created, updated. Example: |
Reference to object.
Reference to object.
See
See .
Success
Success
Success
Success
Success
No Content
No Content
No Content
No Content
No Content
No Content
No Content
No Content
No Content
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Created
Success
Created
Success
Created
Success
Success
Created
Success
Success
Created
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
No Content
Json representation of the product
Created
Json representation of the media
Created
Success
Json representation of the product
Success
Json representation of the document
Created
Json representation of the variant
Created
Success
Mark a document for review.
Field | Type | Description |
---|
Success
| string |
|
| string |
|
| string | The name of the media object. Example: "Office 365 Product Image" |
| 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" |
| string | The type of the media object. |
| string | The URI to access media object. Example: "https://address.to.media.file.pl/abcde.png" |
| integer | Media object order on list. Example: "100" |
| string | Draft or Published. |
| Product Object | Example: |
| Audit Object | Example: |
Get a terms for a product.
Success
List of items in a price list.
Success