This interface provides customization of Voog ecommerce customer e-mails and PDF invoices via templates. A template is a Liquid-enhanced HTML document receiving information about the store and relevant order. If a template is missing or disabled, a built-in default is used.
Get list of templates.
GET /admin/api/ecommerce/v1/templates
Example response:
Status: 200 OK
[
{
"id": 1,
"enabled": true,
"content_type": "customer_invoice",
"component_name": null,
"subject": null,
"content": "<html><head></head><body>PDF invoice</body></html>",
"created_at": "2020-11-17T14:30:09.000Z",
"updated_at": "2020-11-17T14:30:09.000Z"
},
{
"id": 2,
"enabled": true,
"content_type": "customer_payment_notification",
"component_name": null,
"subject": "Payment notification",
"content": "<html><head></head><body>Payment notification</body></html>",
"created_at": "2020-11-17T14:31:09.000Z",
"updated_at": "2020-11-17T14:31:09.000Z"
}
]
Read more about filters.
template
attributes: id
, enabled
, content_type
, component_name
, subject
,
content
, created_at
, updated_at
.GET /admin/api/ecommerce/v1/templates/1
Example request:
GET http://helloworld.voog.com/admin/api/ecommerce/v1/templates/1
Example response:
Status: 200 OK
{
"id": 1,
"enabled": true,
"content_type": "customer_invoice",
"component_name": null,
"subject": null,
"content": "<html><head></head><body>PDF invoice</body></html>",
"created_at": "2020-11-17T14:30:09.000Z",
"updated_at": "2020-11-17T14:30:09.000Z"
}
POST /admin/api/ecommerce/v1/templates
Example data:
{
"enabled": true,
"content_type": "component",
"component_name": "html_head",
"subject": null,
"content": "<head><style>.some-class { background: red; }</style></head>"
}
Example response:
Status: 201 Created
{
"id": 3,
"enabled": true,
"content_type": "component",
"component_name": "html_head",
"subject": null,
"content": "<head><style>.some-class { background: red; }</style></head>",
"created_at": "2020-11-17T14:30:09.000Z",
"updated_at": "2020-11-17T14:30:09.000Z"
}
enabled
— Flag switching the template on or off, true
by default.content_type
— Template's content type, one of customer_invoice
(PDF invoice),
customer_payment_notification
(payment reception notification e-mail),
customer_payment_status_notification
(offline invoice payment reception notification e-mail),
customer_offline_invoice_notification
(offline invoice notification e-mail) or component
(a
code snippet that may be included in other
templates).component_name
— If content_type
is component
, a unique name identifying the component.subject
— If the template specifies an e-mail (i.e. content_type
other than
customer_invoice
or component
), the e-mail's subject line. Supports
Liquid. If blank, a built-in default for the content
type is used.content
— Liquid-enhanced HTML content of the
template or component. If blank, a built-in default for the content type is used.PUT /admin/api/ecommerce/v1/templates/3
This request updates the template with the provided attributes.
Example request:
PUT http://helloworld.voog.com/admin/api/ecommerce/v1/templates/3
Example data:
{
"enabled": true,
"content_type": "component",
"component_name": "html_head",
"subject": null,
"content": "<head><style>.some-class { background: red; }</style></head>"
}
Example response:
Status: 200 OK
{
"id": 3,
"enabled": true,
"content_type": "component",
"component_name": "html_head",
"subject": null,
"content": "<head><style>.some-class { background: red; }</style></head>",
"created_at": "2020-11-17T14:30:09.000Z",
"updated_at": "2020-11-17T14:31:09.000Z"
}
enabled
— Flag switching the template on or off, true
by default.content_type
— Template's content type, one of customer_invoice
(PDF invoice),
customer_payment_notification
(payment reception notification e-mail),
customer_payment_status_notification
(offline invoice payment reception notification e-mail),
customer_offline_invoice_notification
(offline invoice notification e-mail) or component
(a
code snippet that may be included in other
templates).component_name
— If content_type
is component
, a unique name identifying the component.subject
— If the template specifies an e-mail (i.e. content_type
other than
customer_invoice
or component
), the e-mail's subject line. Supports
Liquid. If blank, a built-in default for the content
type is used.content
— Liquid-enhanced HTML content of the
template or component. If blank, a built-in default for the content type is used.DELETE /admin/api/ecommerce/v1/templates/1
This request deletes the given template.
Example request:
DELETE http://helloworld.voog.com/admin/api/ecommerce/v1/templates/1
Example response:
Status: 204 No Content