Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Template
object provides functionality for templates to be made and automatically delivered once a set of rules based on type is achieved. This enables the client to know what is happening with their order and if anything is needed of them.
id
string
Template ID.
Example: "TPL-1234-5678"
href
string
Relative reference to object on API (always products/{id}/templates/{id}
)
Example: "v1/products/PRD-1234-1234/templates/TPL-1234-5678-0001"
name
string
Template name
Example: "Thank you for your interest"
type
string
Example: "RequestProcessing"
content
string
Content for the template.
Example:
default
boolean
Each product will have 4 defaults automatically generated upon product creation (against each status)
Each template automatically created will have a default system message client account will need to update these
Default cannot be deleted
Non default can be deleted
Example: "true"
product
Example:
audit
Audit Object
Update a template for a product.
Create a template for a product.
Get a list of templates for a product.
The following diagram shows the possible states for the templates object in the Marketplace Platform and the transition between these states:
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.
Get a template for a product.
Delete a template for a product.
/v1/products/{productId}/templates
/v1/products/{productId}/templates/{id}
/v1/products/{productId}/templates/{id}
No body
/v1/products/{productId}/templates/{id}
/v1/products/{productId}/templates
OrderProcessing
, OrderQuerying
, OrderCompleted
, RequestProcessing