NAV
bash

Introduction

Welcome to the ViaAds API documentation.

This page provides all the information you need to successfully integrate your webshop with ViaAds.

Here you will find the specific endpoints, with the properties required for ViaAds to perform Successful marketing for your webshop.

Furthermore the Schemas is also listed on this page, with a short description of every property, along with any relations there might be between them.

Support - Website

Authentication

To authenticate your requests to the ViaAds API, you will need to include your API key in the header of each request.

ApiKey: key123

Custom

Event [OPTIONAL]

curl -X 'POST' \
  'https://integration.viaads.dk/event' \
  -H 'accept: */*' \
  -H 'ApiKey: test' \
  -H 'Content-Type: application/json' \
  -d '{
  "eventDate": "2023-06-14T08:38:56.936Z",
  "eventType": "string",
  "productSku": "string",
  "price": 0,
  "email": "string",
  "cookie": "string",
  "clientIpAddress": "string",
  "userAgent": "string"
}'

JSON response example:

{
  "status": 200,
  "message": "Success"
}

This endpoint is used to receive customer events e.g. Viewed Product, Added Product To Cart or Removed Product From Cart.

EventTypes:
[ProductLook, AddCart, RemoveCart, AddWishList, RemoveWishList]

HTTP Request

POST https://integration.viaads.dk/event

Order [OPTIONAL]

curl -X 'POST' \
  'https://integration.viaads.dk/order' \
  -H 'accept: */*' \
  -H 'ApiKey: 123' \
  -H 'Content-Type: application/json' \
  -d '{
  "createdGmt": "2023-06-16T07:48:54.804Z",
  "lastModifiedGmt": "2023-06-16T07:48:54.804Z",
  "orderNumber": "string",
  "currencyIsoCode": "string",
  "email": "string",
  "status": "string",
  "isCanceled": true,
  "totalShippingPrice": 0,
  "totalPriceWithOutTax": 2147483647,
  "totalPriceWithTax": 2147483647,
  "items": [
    {
      "name": "string",
      "sku": "string",
      "unitPrice": 0,
      "quantity": 0,
      "totalPriceWithTax": 0,
      "totalPriceWithOutTax": 0
    }
  ],
  "billing": {
    "billingFirstName": "string",
    "billingLastName": "string",
    "billingAddress": "string",
    "billingCity": "string",
    "billingState": "string",
    "billingZipCode": "string",
    "billingCountry": "string",
    "billingPhoneNumber": "string",
    "billingEmail": "string"
  },
  "shipping": {
    "shippingFirstName": "string",
    "shippingLastName": "string",
    "shippingPhoneNumber": "string",
    "shippingEmail": "string"
  }
}'

JSON response example:

{
  "status": 200,
  "message": "Success"
}

This endpoint is used to receive a single customer order. This enables more efficient retargeting if an order is sent directly after its created This endpoint is not included as an 'Event' and is therefore not restricted by the Marketing Cookie Acceptance

HTTP Request

POST https://integration.viaads.dk/order

Orders [REQUIRED]

curl -X 'POST' \
  'https://integration.viaads.dk/orders' \
  -H 'accept: */*' \
  -H 'ApiKey: 123' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "createdGmt": "2023-06-16T07:48:21.176Z",
    "lastModifiedGmt": "2023-06-16T07:48:21.176Z",
    "orderNumber": "string",
    "currencyIsoCode": "string",
    "email": "string",
    "status": "string",
    "isCanceled": true,
    "totalShippingPrice": 0,
    "totalPriceWithOutTax": 2147483647,
    "totalPriceWithTax": 2147483647,
    "items": [
      {
        "name": "string",
        "sku": "string",
        "unitPrice": 0,
        "quantity": 0,
        "totalPriceWithTax": 0,
        "totalPriceWithOutTax": 0
      }
    ],
    "billing": {
      "billingFirstName": "string",
      "billingLastName": "string",
      "billingAddress": "string",
      "billingCity": "string",
      "billingState": "string",
      "billingZipCode": "string",
      "billingCountry": "string",
      "billingPhoneNumber": "string",
      "billingEmail": "string"
    },
    "shipping": {
      "shippingFirstName": "string",
      "shippingLastName": "string",
      "shippingPhoneNumber": "string",
      "shippingEmail": "string"
    }
  }
]'

JSON response example:

{
  "status": 200,
  "message": "Success"
}

This endpoint is used to receive a daily list of customer orders

HTTP Request

POST https://integration.viaads.dk/orders

bash