Conversion

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
Store

API endpoint:

POST 
https://heimdall.show/api/v1/conversion

Request example: 

curl --location --request POST 'https://heimdall.show/api/v1/conversion' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Parameter
Type
Description
domain
required string
The domain name.
netTotal
required string
The order subtotal amount after discounts are added but before additional fees such as taxes, delivery charges, or service charges are added.
finalTotalGrossAmount
optional string
The final total basket amount.
referenz
required string
The reference id for your order like your Order-Number
date
optional string
The date of the Conversion
basketProductCount
optional integer
Count of products in the basket.
productIds
optional string
ProductIds in the Basket. Example: "1234,2345,6789"
quantities
optional string
Quantity of the Products. Example: "1,3,1"
channel
optional string
The name of the channel that identified as the last click referrer.
voucher
optional string
The voucher code used in the transaction. Example: "GET10,WELCOME,5off"
customersOrderCount
optional integer
The Order Count of the Customer. If it is his first order then "1" else ":numberOfOrders"
Update

API endpoint:

PUT PATCH 
https://heimdall.show/api/v1/conversion/{id}

Request example: 

curl --location --request PUT 'https://heimdall.show/api/v1/conversion/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
netTotal
required string
The order subtotal amount after discounts are added but before additional fees such as taxes, delivery charges, or service charges are added.
finalTotalGrossAmount
optional string
The final total basket amount.
referenz
required string
The reference id for your order like your Order-Number
date
optional string
The date of the Conversion
basketProductCount
optional integer
Count of products in the basket.
productIds
optional string
ProductIds in the Basket. Example: "1234,2345,6789"
quantities
optional string
Quantity of the Products. Example: "1,3,1"
channel
optional string
The name of the channel that identified as the last click referrer.
voucher
optional string
The voucher code used in the transaction. Example: "GET10,WELCOME,5off"
customersOrderCount
optional integer
The Order Count of the Customer. If it is his first order then "1" else ":numberOfOrders"