Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
Get a list of all terms for a product.
Delete terms for a product.
Create terms for a product.
Get a terms 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:
Update the terms for a product.
Publish the terms for a product.
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
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. |
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:
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:
Mark the terms for a product for review.
Unpublish the terms for a product.