Vendre Help - Användarbidrag [sv]

Templating:Webhooks

2026-06-03T10:53:03Z

Johan: Skapade sidan med 'This page documents the Twig template variables available when formatting webhook payloads and URLs. ==Twig variables== ===Context variables=== These variables are passed gl...'

This page documents the Twig template variables available when formatting webhook payloads and URLs.

==Twig variables==

===Context variables===
These variables are passed globally into the Twig context when a webhook event is triggered.

{|class="wikitable"
!variable
!description
|-
|payload
|The primary data payload object containing the event-specific details.
|-
|data
|An alias for <tt>payload</tt>.
|-
|order
|An alias for <tt>payload</tt> (provided for convenience when dealing with order-specific events).
|-
|trigger
|The decoded configuration or structural data that initiated the webhook trigger.
|-
|webhook_event
|The exact name of the event that fired the webhook (e.g., <tt>order.created</tt>).
|-
|webhook
|An array containing metadata about the configured webhook itself. See the table below for sub-properties.
|-
|now
|The current system timestamp at execution time, formatted as an ISO 8601 string.
|}

===Webhook metadata properties===
These properties are accessible nested inside the <tt>webhook</tt> array variable.

{|class="wikitable"
!variable
!description
|-
|webhook.id
|The database ID of the specific webhook URL configuration.
|-
|webhook.url
|The target destination URL where the payload is dispatched.
|-
|webhook.type
|The integration type classification assigned to this webhook.
|-
|webhook.method
|The HTTP request method used for the payload delivery (e.g., <tt>POST</tt>, <tt>GET</tt>, <tt>PUT</tt>).
|-
|webhook.data_format
|The format structure expected by the payload (e.g., <tt>json</tt>, <tt>xml</tt>).
|-
|webhook.data_filter
|The filter rule configuration string or logic applied to this webhook.
|}

Bootstrap:Menu

2026-06-03T10:48:44Z

Johan:

* Design och layout
** [[Templating:Variables|Mallvariabler för butikssidor]]
** [[Templating:Emails|Mallvariabler för mailutskick]]
** [[Templating:Printed orders|Mallvariabler för orderutskrifter]]
** [[Templating:Webhooks|Mallvariabler för webhooks]]
** [[FTP & SFTP|Filåtkomst via SFTP]]
** [[Forms|Formulär]]

Errors:Specification

2025-06-12T14:48:17Z

Johan: Tömde sidan

Errors:Examples

2025-06-12T14:48:01Z

Johan: Tömde sidan

Huvudsida

2025-06-12T14:46:28Z

Johan:

=Vendre support page=
'''Vendre support is located att [http://support.vendre.io support.vendre.io]'''

=Vendre Surface API=
* API
**[[Surface]]

=Vendre template variables=
{{:Bootstrap:Menu}}

=Error Messages=
*[[Errormessages|Error Messages]]

Errormessages

2025-06-12T14:45:29Z

Johan: Skapade sidan med '== Specification == ; ID (optional) : A unique identifier for this particular occurrence of the problem. Can be used if the error is logged to improve troubleshooting. ; STAT...'

== Specification ==
; ID (optional)
: A unique identifier for this particular occurrence of the problem. Can be used if the error is logged to improve troubleshooting.

; STATUS (optional)
: The HTTP status code applicable to this problem.

; CODE (required)
: An application-specific error code. The meaning can be internal or public depending on sensitivity. Facilitates troubleshooting. Sensitive information can be hidden behind a code. Localization of error messages can be done through this code.

; PUBLIC (optional)
: A boolean indicating if TITLE and DETAIL can be shown to end users. It SHOULD be present if either TITLE or DETAIL is provided.

; TITLE (optional)
: A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

; DETAIL (optional)
: A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

; SOURCE (optional)
: An object containing references to the primary source of the error. It SHOULD include one of its properties or be omitted. Useful when troubleshooting or showing validation errors.

:; POINTER
:: A JSON Pointer [RFC6901] to the value in the request document that caused the error.

:; PARAMETER
:: A string indicating which URI query parameter caused the error.

:; HEADER
:: A string indicating the name of a single request header which caused the error.

== Examples ==
=== VQL - Invalid attribute and invalid relation ===
The query can return valid data in addition to one or more errors.
; Request
<pre>
{
"query:MinProdukt": {
"products": {
"filters": {
"where": {
"id": 183
},
"limit": 10
},
"fields": [
"id",
"name",
"tax_rate",
"invalid_attribute",
{
"invalidRelation": {
"fields": [
"_all"
]
}
}
]
}
}
}
</pre>

; Response
<pre>
{
"data": {
"MinProdukt": {
"products": [
{
"id": 183,
"name": "Clementine Dress",
"tax_rate": 25
}
]
}
},
"errors": [
{
"id": "062b392d-fb87-48bf-a898-54615a5946c0",
"status": "422",
"code": "VQL_ERROR_INVALID_ATTRIBUTE",
"public": true,
"title": "Invalid attribute requested.",
"detail": "The requested attribute: invalid_attribute is invalid.",
"source": {
"pointer": "/query:MinProdukt/products/fields/3"
}
},
{
"id": "5fd5445d-f670-42d5-a966-a3d13d218f4c",
"status": "422",
"code": "VQL_ERROR_INVALID_RELATION",
"public": true,
"title": "Invalid relation requested.",
"detail": "The requested relation: invalid_relation is invalid.",
"source": {
"pointer": "/query:MinProdukt/products/fields/4"
}
}
]
}
</pre>

=== VQL - Invalid json ===
; Request
<pre>
{
"invalid_json": {
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "400",
"code": "VQL_ERROR_MALFORMED_BODY",
"public": false,
"title": "Malformed request body."
}
]
}
</pre>

=== Surface - 403 ===
; Request
<pre>
{
"route": "surface/1/voucher/value?voucher=2",
"method": "POST"
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "403",
"code": "VOUCHER_ERROR_8C3D7270"
}
]
}
</pre>

=== Surface - 403 with title ===
; Request
<pre>
{
"route": "surface/1/voucher/value?voucher=2",
"method": "POST"
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "403",
"code": "VOUCHER_ERROR_8C3D7270",
"public": false,
"title": "Disabled through cright."
}
]
}
</pre>

=== Surface - title that can be used ===
; Request
<pre>
{
"route": "surface/1/bankid/qr-token",
"method": "GET"
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "422",
"code": "BANKID_NO_ACTIVE_SESSION",
"public": true,
"title": "BankID session not started."
}
]
}
</pre>

Huvudsida

2025-06-12T14:44:32Z

Johan:

Errors:Examples

2025-06-12T14:40:07Z

Johan:

== Examples ==
=== VQL - Invalid attribute and invalid relation ===
The query can return valid data in addition to one or more errors.
; Request
<pre>
{
"query:MinProdukt": {
"products": {
"filters": {
"where": {
"id": 183
},
"limit": 10
},
"fields": [
"id",
"name",
"tax_rate",
"invalid_attribute",
{
"invalidRelation": {
"fields": [
"_all"
]
}
}
]
}
}
}
</pre>

; Response
<pre>
{
"data": {
"MinProdukt": {
"products": [
{
"id": 183,
"name": "Clementine Dress",
"tax_rate": 25
}
]
}
},
"errors": [
{
"id": "062b392d-fb87-48bf-a898-54615a5946c0",
"status": "422",
"code": "VQL_ERROR_INVALID_ATTRIBUTE",
"public": true,
"title": "Invalid attribute requested.",
"detail": "The requested attribute: invalid_attribute is invalid.",
"source": {
"pointer": "/query:MinProdukt/products/fields/3"
}
},
{
"id": "5fd5445d-f670-42d5-a966-a3d13d218f4c",
"status": "422",
"code": "VQL_ERROR_INVALID_RELATION",
"public": true,
"title": "Invalid relation requested.",
"detail": "The requested relation: invalid_relation is invalid.",
"source": {
"pointer": "/query:MinProdukt/products/fields/4"
}
}
]
}
</pre>

=== VQL - Invalid json ===
; Request
<pre>
{
"invalid_json": {
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "400",
"code": "VQL_ERROR_MALFORMED_BODY",
"public": false,
"title": "Malformed request body."
}
]
}
</pre>

=== Surface - 403 ===
; Request
<pre>
{
"route": "surface/1/voucher/value?voucher=2",
"method": "POST"
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "403",
"code": "VOUCHER_ERROR_8C3D7270"
}
]
}
</pre>

=== Surface - 403 with title ===
; Request
<pre>
{
"route": "surface/1/voucher/value?voucher=2",
"method": "POST"
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "403",
"code": "VOUCHER_ERROR_8C3D7270",
"public": false,
"title": "Disabled through cright."
}
]
}
</pre>

=== Surface - title that can be used ===
; Request
<pre>
{
"route": "surface/1/bankid/qr-token",
"method": "GET"
}
</pre>

; Response
<pre>
{
"errors": [
{
"status": "422",
"code": "BANKID_NO_ACTIVE_SESSION",
"public": true,
"title": "BankID session not started."
}
]
}
</pre>

Errors:Examples

2025-06-12T14:26:24Z

Johan: Skapade sidan med '== Examples == === Example 1 === ; Request <syntaxhighlight lang="json"> { "query:MinProdukt": { "products": { "filters": { "where": { "id": 183...'

== Examples ==
=== Example 1 ===
; Request
<syntaxhighlight lang="json">
{
"query:MinProdukt": {
"products": {
"filters": {
"where": {
"id": 183
},
"limit": 10
},
"fields": [
"id",
"name",
"tax_rate",
"invalid_attribute",
{
"invalidRelation": {
"fields": [
"_all"
]
}
}
]
}
}
}
</syntaxhighlight>

; Response
<syntaxhighlight lang="json">
{
"data": {
"MinProdukt": {
"products": [
{
"id": 183,
"name": "Clementine Dress",
"tax_rate": 25
}
]
}
},
"errors": [
{
"id": "062b392d-fb87-48bf-a898-54615a5946c0",
"status": "422",
"code": "VQL_ERROR_INVALID_ATTRIBUTE",
"public": true,
"title": "Invalid attribute requested.",
"detail": "The requested attribute: invalid_attribute is invalid.",
"source": {
"pointer": "/query:MinProdukt/products/fields/3"
}
},
{
"id": "5fd5445d-f670-42d5-a966-a3d13d218f4c",
"status": "422",
"code": "VQL_ERROR_INVALID_RELATION",
"public": true,
"title": "Invalid relation requested.",
"detail": "The requested relation: invalid_relation is invalid.",
"source": {
"pointer": "/query:MinProdukt/products/fields/4"
}
}
]
}
</syntaxhighlight>

=== Example 2 ===
; Request
<syntaxhighlight lang="json">
{
"invalid_json": {}
}
</syntaxhighlight>

; Response
<syntaxhighlight lang="json">
{
"errors": [
{
"status": "400",
"code": "VQL_ERROR_MALFORMED_QUERY",
"public": false,
"title": "Malformed request body."
}
]
}
</syntaxhighlight>

=== Example 3 ===
; Request
<syntaxhighlight lang="json">
{
"route": "surface/1/voucher/value?voucher=2",
"method": "POST"
}
</syntaxhighlight>

; Response
<syntaxhighlight lang="json">
{
"errors": [
{
"status": "403",
"code": "VOUCHER_ERROR_8C3D7270"
}
]
}
</syntaxhighlight>

=== Example 4 ===
; Request
<syntaxhighlight lang="json">
{
"route": "surface/1/voucher/value?voucher=2",
"method": "POST"
}
</syntaxhighlight>

; Response
<syntaxhighlight lang="json">
{
"errors": [
{
"status": "403",
"code": "VOUCHER_ERROR_8C3D7270",
"public": false,
"title": "Disabled through cright."
}
]
}
</syntaxhighlight>

=== Example 5 ===
; Request
<syntaxhighlight lang="json">
{
"route": "surface/1/bankid/qr-token",
"method": "GET"
}
</syntaxhighlight>

; Response
<syntaxhighlight lang="json">
{
"errors": [
{
"status": "422",
"code": "BANKID_NO_ACTIVE_SESSION",
"public": true,
"title": "BankID session not started."
}
]
}
</syntaxhighlight>

Huvudsida

2025-06-12T14:11:05Z

Johan:

Errors:Specification

2025-06-12T14:10:07Z

Johan: Skapade sidan med '; ID (optional) : A unique identifier for this particular occurrence of the problem. Can be used if the error is logged to improve troubleshooting. ; STATUS (optional) : The...'

; ID (optional)
: A unique identifier for this particular occurrence of the problem. Can be used if the error is logged to improve troubleshooting.

; STATUS (optional)
: The HTTP status code applicable to this problem.

; CODE (required)
: An application-specific error code. The meaning can be internal or public depending on sensitivity. Facilitates troubleshooting. Sensitive information can be hidden behind a code. Localization of error messages can be done through this code.

; PUBLIC (optional)
: A boolean indicating if TITLE and DETAIL can be shown to end users. It SHOULD be present if either TITLE or DETAIL is provided.

; TITLE (optional)
: A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

; DETAIL (optional)
: A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

; SOURCE (optional)
: An object containing references to the primary source of the error. It SHOULD include one of its properties or be omitted. Useful when troubleshooting or showing validation errors.

:; POINTER
:: A JSON Pointer [RFC6901] to the value in the request document that caused the error.

:; PARAMETER
:: A string indicating which URI query parameter caused the error.

:; HEADER
:: A string indicating the name of a single request header which caused the error.

Huvudsida

2025-06-12T13:30:58Z

Johan:

Huvudsida

2025-06-12T11:53:24Z

Johan:

Surface

2024-11-21T09:58:33Z

Johan:

=Surface API=
Our StoreFront API to fetch data through Vue or other comparable frameworks.<br />
Basepath for all calls, '''/surface/1/''', using version 1.<br />
eg. '''/surface/1/request-password-change'''

==How to use==
$.post(
"/surface/1/appforsales/history/invoice",
{ invoice_number : '000192' },
function(data) {
console.log(data);
}
);

$.post(
"/surface/1/extended-product-data-field",
{ "product_id": 3879, "fields": [{ "id": 11 }] },
function(data) {
console.log(data);
}
);

==NOTE==
You need an active session to use the Surface-call, otherwise you will get a 401-response. (If you're using Postman or Insomnia). So work on it from the browser.

==Available Surface Calls==
===POST: appforsales/history/orders===
rows
offset

===POST: appforsales/history/order===
order_number

===POST: appforsales/history/invoices===
rows
offset

===POST: appforsales/history/invoice===
invoice_number

===GET: bankid/status===
status från bankid-sessionen
===GET: bankid/qr-token===
qr från bankid-sessionen
===POST: bankid/login===
utgår från bankid som används
===POST: custom-reports/report-request===
unique_key
email
format
filters
Hämtar användaruppgifter från sessionen
===GET: custom-reports/report===
*Bör ändras till GET-variabler
unique_key
format
fiilters
===POST: extended-product-data-field===
BODY: { "product_id": 5555, "fields": [{ "id": 4553, "languages": [4,5,8] }, { "id": 1234 }] }

===POST: login-link===
email
Hämtar marknad och språk från sessionen
===GET: product-list===
hash_id
===POST: product-list/shared-cart===
hämtar varukorgen från sessionen
===GET: products/associated===
order_by
product_id
replace_variants
type_id
===GET: products/price-log-prices===
id
===GET: products/stock===
id
===GET: products/configuration-price===
product_id
configuration
quantity
<br>
===POST: request-for-quotation===
hämtar kundid och språk från sessionen
<br>
===POST: request-password-change===
email
id
hämtar marknad och språk från sessionen
===POST: reservations===
name
email
phone
Products
partner_id
data
Hämtar kundid från sessionen
Postar allt man skickar in
===GET: shopping-cart===
Hämtar varukorgen från sessionen
===DELETE: shopping-cart===
Tömmer varukorgen för sessionen
===GET: shopping-cart/products===
Hämtar varukorgen från sessionen
===POST: shopping-cart/products===
products
===GET: tweakwise/featured-products===
display_id
===POST: vql===
Separat dokumentation för Vendre Query Language
https://support.vendre.io/i/for-utvecklare-868/vql-10-vendre-query-language.html
===POST: voucher/value===
voucher
Hämtar currency från sessionen