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.
Field
Type
Description
id
string
Terms identifier.
Example: "TCS-1234-1234-1234"
href
string
Relative reference to terms to product (/products/{productid}/terms-and-conditions/{termsAndConditionsId}
Example:
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:
Example
{"id":"TCS-3159-1891-0980-8679","href":"/products/PRD-6822-9898-4256/terms-and-conditions/TCS-3159-1891-0980-8679","name":"Microsoft 365 Terms of Service","description":"Description of Microsoft 365 Terms of Service","displayOrder":100,"state":"Draft","product": {"id":"PRD-6822-9898-4256","href":"/products/PRD-6822-9898-4256","name":"Microsoft 365 online services for commercial" },"audit": {"created": {"at":"2024-01-16T21:30:13.1046031","by": {"id":"USR-0000-0001" } },"updated":null }}
TermsVariant
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.
Field
Type
Description
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:
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:
Example
{"id":"TCS-1234-1234-1234-1234","href":"/products/PRD-1234-1234/terms/tcs-1234-1234-1234/terms-item/tcs-1234-1234-1234-1234","name":"Terms and Conditions Variant - EN","description":"Terms and Conditions Variant in English","type":"Online","assetUrl":"https://www.microsoft.com","languageCode":"en","state":"Draft","termsAndConditions": {"id":"TCS-1234-1234-1234","href":"/products/PRD-1234-1234/terms/tcs-1234-1234-1234","name":"Microsoft 365 Terms of Service" },"audit": {"created": {"at":"2024-01-16T21:30:13.1046031","by": {"id":"USR-0000-0001" } },"updated":null }}
Publish Terms
Publish the terms for a product.
Update Terms
Update the terms for a product.
Unpublish Terms
Unpublish the terms for a product.
Mark Terms For Review
Mark the terms for a product for review.
Terms & Conditions States
The following diagram shows the possible states for the terms and conditions object in the Marketplace Platform and the transition between these states:
State
Definition
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.
