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