Back to top

Venue Manager shop API - Core

REST-interface for the Venue Manager shop platform.

This document describes the core endpoints.

Links to the other modules’ endpoints can be found at http://docs.api.venuemanager.net/.

Many endpoints requires a JSON Web Token for authorization. Please see the section Create token for information about how to get a token.

Demo endpoints

A collection of simple endpoints demonstrating datatypes and errors.

integer

integer
GET/test/integer

Returns a simple integer.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/test/integer
Response  200
HideShow
Headers
Content-Type: application/json
Body
42

integerArray

integerArray
GET/test/integerArray

Returns an array of integers.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/test/integerArray
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  1,
  1,
  2,
  3,
  5,
  8,
  13,
  21,
  34,
  55,
  89
]

string

string
GET/test/string

Returns a simple string.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/test/string
Response  200
HideShow
Headers
Content-Type: application/json
Body
"This result is a simple string value."

object

object
GET/test/object

Returns an object.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/test/object
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "42",
  "label": "exampleObject",
  "days": [
    "mon",
    "tue",
    "wed",
    "thu",
    "fri",
    "sat",
    "sun"
  ]
}

noContent

noContent
GET/test/noContent

This endpoint has an empty response body.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/test/noContent
Response  204

forbidden

forbidden
GET/test/forbidden

This endpoint always fails.

Errors are reported with 4xx or 5xx HTTP status codes and a body with information about the error.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/test/forbidden
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Configuration endpoints

Address configuration

Get address configuration
GET/config/address?languageCode={languageCode}&addressType={addressType}

Get the address configuration for a customer.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/config/address?languageCode=da&addressType=season_card
URI Parameters
HideShow
languageCode
string (required) Example: da

The language the fields should be translated as. If missing, or unknown to the shop, the default language will be used

addressType
string (optional) Example: season_card

Label of the address type to get fields for. Default is “billing”.

Request
HideShow
Headers
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "field": "firstname",
    "type": "string",
    "name": "Fornavn",
    "url": "http://shop.venuemanager.net/side/privacy",
    "required": true,
    "optionalOnCreation": true,
    "values": [
      {
        "value": "M",
        "name": "Mand"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Geofence configuration

Get Geofences
GET/config/geofence?languageCode={languageCode}

Get configuration for all available Geofences for this shop.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/config/geofence?languageCode=da
URI Parameters
HideShow
languageCode
string (required) Example: da

The language the fields should be translated as. If missing, or unknown to the shop, the default language will be used

Request
HideShow
Headers
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "latitude": 56.131973,
    "longitude": 10.193669,
    "radius": 120,
    "name": "Ceres Arena",
    "topics": {
      "inside": "/topic/agf/geofence_inside/1",
      "outside": "/topic/agf/geofence_outside/1"
    },
    "messages": {
      "in": {
        "title": "Velkommen til VM Arena",
        "body": "Velokmmen til VM Arena"
      },
      "out": {
        "title": "Velkommen til VM Arena",
        "body": "Velokmmen til VM Arena"
      }
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Customer endpoints

Customer

Create customer
POST/customer

Creates a customer, and returns its ID and a token.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "password": "Hello, world!",
  "address": [
    {
      "field": "street",
      "value": "Dannebrogsgade 58A"
    }
  ],
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "password": {
      "type": "string"
    },
    "address": {
      "type": "array"
    },
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "password",
    "address",
    "clientName"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 17721,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w",
  "customerId": 17721
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID of the token"
    },
    "token": {
      "type": "string"
    },
    "customerId": {
      "type": "number",
      "description": "ID of the customer"
    }
  },
  "required": [
    "id",
    "token",
    "customerId"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Argument 'password' missing or empty.",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Get customer
GET/customer/{customerId}?clientName={clientName}&clientOs={clientOs}

Returns username and address for the customer.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/customer/17721?clientName=VenueApp&clientOs=iPhone
URI Parameters
HideShow
customerId
number (required) Example: 17721
clientName
string (required) Example: VenueApp

Used by the server to identify the App in use

clientOs
string (required) Example: iPhone

iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists.

Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 17721,
  "username": "sta@combine.dk",
  "address": [
    {
      "field": "street",
      "value": "Dannebrogsgade 58A"
    }
  ],
  "data": [
    {
      "label": "seasonRank",
      "value": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "username": {
      "type": "string"
    },
    "address": {
      "type": "array"
    },
    "data": {
      "type": "array",
      "description": "Object with various extra data for the customer"
    }
  },
  "required": [
    "id",
    "username",
    "address",
    "data"
  ]
}

Edit customer
POST/customer/{customerId}

Updates the customers address fields.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/17721
URI Parameters
HideShow
customerId
number (required) Example: 17721
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "address": [
    {
      "field": "street",
      "value": "Dannebrogsgade 58A"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "address": {
      "type": "array"
    }
  },
  "required": [
    "address"
  ]
}
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Addressfield could not be updated.",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "No customer logged in.",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Password

Change password
POST/customer/updatePass

Change the password of the customer.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/updatePass
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "oldPassword": "Hello, world!",
  "newPassword": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "oldPassword": {
      "type": "string"
    },
    "newPassword": {
      "type": "string"
    }
  },
  "required": [
    "oldPassword",
    "newPassword"
  ]
}
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Den gamle adgangskode er forkert",
  "errorCode": 1001
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Reset password
POST/customer/resetpass

Sends a link to the customer e-mail for resetting their password.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/resetpass
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    }
  },
  "required": [
    "username"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Du vil snarest modtage et link per mail til at nulstille din adgangskode."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Ukendt brugernavn.",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Customer Tokens

The customer tokens are JSON Web Tokens. By utilizing customer tokens you can avoid storing the customer’s password in your application and still authorize as that customer against the API.

Create token
POST/customer/token

Creates a JSON Web Token (JWT) that can be used in subsequent calls to the API.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/token
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "alice@example.com",
  "password": "Bob is cute",
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "username": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "username",
    "password",
    "clientName"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 17721,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w",
  "customerId": 17721
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID of the token"
    },
    "token": {
      "type": "string"
    },
    "customerId": {
      "type": "number",
      "description": "ID of the customer"
    }
  },
  "required": [
    "id",
    "token",
    "customerId"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Argument 'username' missing or empty.",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Cannot login with supplied username and password.",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Validate token
GET/customer/token

This endpoint can be used to check if a token is valid.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/customer/token
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Response  204
HideShow

No content is returned when the token is valid.

Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Invalid token",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Data token

Create data token
POST/customer/dataToken

Creates a JSON Web Token (JWT) with extended payload. This token can also be used for subsequent calls to the API, but requires a simple bearer token to be created.

The payload contains the following extra fields:

  • name - The full name, if part of the billing address type

  • given_name - The first name, if part of the billing address type

  • family_name - The surname, if part of the billing address type

  • email - Email

  • phone_number - Mobile or phone number, if part of the billing address type

  • season_rank - Highest card type rank

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/dataToken
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "token": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    }
  },
  "required": [
    "token"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 17721,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w",
  "customerId": 17721
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID of the token"
    },
    "token": {
      "type": "string"
    },
    "customerId": {
      "type": "number",
      "description": "ID of the customer"
    }
  },
  "required": [
    "id",
    "token",
    "customerId"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Invalid token",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Customer Push Tokens

Set push token
POST/customer/pushToken

Set the token to be used for pushing notifications to the customer. Will overwrite any existing push tokens for that customer.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/pushToken
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "token": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    }
  },
  "required": [
    "token"
  ]
}
Response  204

Guest Tokens

Create guest token
POST/customer/guestToken

Creates a JSON Web Token (JWT) for a guest customer.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/guestToken
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required)"
    }
  },
  "required": [
    "clientName"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 17721,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w",
  "customerId": 17721
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID of the token"
    },
    "token": {
      "type": "string"
    },
    "customerId": {
      "type": "number",
      "description": "ID of the customer"
    }
  },
  "required": [
    "id",
    "token",
    "customerId"
  ]
}

One-time tokens for customer login at shop frontend

The one-time tokens can be used to allow a customer login in the shop frontend without entering username and password.

The default lifetime of a token is 60s.

URL’s for login is in the form: <url>/?login_by_token=<token_value>

Create one-time token
POST/customer/onetimetoken

This endpoint generates and returns a token for login at the shop.

Note that is not the same token as for authorization in the API.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/onetimetoken
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "clientName"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "token": "2d0002947ce783aaea1a29d4c04bec5b066ac56f"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "Token for login at the shop"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Invalid token",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Customer anonymization

Check if customer can be anonymized
GET/customer/anonymize{?clientName,clientOs}

Checks if the customer can be anonymized. If so the returned object will have canBeAnonymized set to true. If not, canBeAnonymized will be set to false, and reasons will contain an array of all reasons why anonymization is not allowed.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/customer/anonymize?clientName=VenueApp&clientOs=iPhone
URI Parameters
HideShow
clientName
string (required) Example: VenueApp

Used by the server to identify the App in use

clientOs
string (required) Example: iPhone

iOS - 12.0 (string, required)

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "canBeAnonymized": true,
  "reasons": [
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "canBeAnonymized": {
      "type": "boolean"
    },
    "reasons": {
      "type": "array"
    }
  }
}

Anonymize customer
POST/customer/anonymize

Anonymize the customer, and everything related to it.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/anonymize
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Body
{
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required)"
    }
  },
  "required": [
    "clientName"
  ]
}
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "The customer cannot be anonymized for the following reasons: xxx",
  "errorCode": 1000
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Customer payment cards

Some payment service providers (eg QuickPay) allow the customer to register a payment card as a “saved card”. The saved card can then be used to authorize payments without requiring the customer to enter his card details again. This is useful for 1-click payments, subscriptions and payment in installments.

List payment cards
GET/customer/paymentcards?clientName={clientName}&clientOs={clientOs}

Returns the customer’s saved payment cards.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/customer/paymentcards?clientName=VenueApp&clientOs=iPhone
URI Parameters
HideShow
clientName
string (required) Example: VenueApp

Used by the server to identify the App in use

clientOs
string (required) Example: iPhone

iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists.

Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 10,
    "brand": "VISA",
    "number": "100000...3333",
    "expire_year": 2017,
    "expire_month": 12
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Add new payment card
POST/customer/paymentcards

Initiates the process of adding a new card for the given customer.

The server will return a URL to the Payment Service Provider’s website where the customer can enter his payment card details.

When the registration is completed the customer’s browser is redirected to one of the URLs supplied in the request. Upon success the parameter cardId=<integer> is added to successUrl.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/customer/paymentcards
Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "successUrl": "http://example.com/success",
  "failedUrl": "http://example.com/argh",
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "type": "object",
  "properties": {
    "successUrl": {
      "type": "string",
      "description": "URL for redirect after successful registration of a new card.\n\n`cardId=<integer>` is added to URL."
    },
    "failedUrl": {
      "type": "string",
      "description": "URL for redirect when the registration fails."
    },
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "successUrl",
    "failedUrl",
    "clientName"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Location: https://payment.quickpay.net/cards/61f10da63a70e44d1e1614b052f7754fec8d5bf52ef44e0dcbc86c7db9f1aa19

Customer Group endpoints

Customer groups

Get all
GET/customergroup

Get all customer groups.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/customergroup
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 17721,
    "name": "Sponsor",
    "type": "normal"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Order endpoints

Orders

Create order
POST/order

Creates a new order for the customer.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/order
Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "orderLines": [
    {
      "sellableId": 23,
      "productId": 51,
      "quantity": 5,
      "date": "2019-02-19",
      "properties": {
        "name": "Fornavn Efternavn",
        "email": "kunde@example.org",
        "dateOfBirth": "2019-02-19",
        "street": "Dannebrogsgade 58A",
        "zipCode": "9000",
        "city": "Aalborg",
        "countryCode": "DK",
        "imageId": 5823,
        "oldCardId": 5823
      }
    }
  ],
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "type": "object",
  "properties": {
    "orderLines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sellableId": {
            "type": "number",
            "description": "One of (sellableId|productId) is required."
          },
          "productId": {
            "type": "number",
            "description": "One of (sellableId|productId) is required."
          },
          "quantity": {
            "type": "number"
          },
          "date": {
            "type": "string",
            "description": "The date to buy the product for. Only relevant for products with inventory per date"
          },
          "properties": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "string"
              },
              "street": {
                "type": "string"
              },
              "zipCode": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "countryCode": {
                "type": "string"
              },
              "imageId": {
                "type": "number"
              },
              "oldCardId": {
                "type": "number",
                "description": "Required when renewing a seasoncard"
              }
            }
          }
        },
        "required": [
          "quantity"
        ]
      }
    },
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "orderLines",
    "clientName"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow

Order created succesfully.

Headers
Location: https://customer.admin.venuemanager.net/api/core/order/{orderId}
Body
{
  "id": 65478,
  "number": "AB1C2D3E"
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "ID of the created order"
    },
    "number": {
      "type": "string",
      "description": "Number of the created order"
    }
  },
  "required": [
    "id",
    "number"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Order transactions

All payment information for an order is stored in order transactions.

Most orders have only a single order transactions, but it is possible to have several.

Pay order with saved card
POST/order/ordertransaction/savedcard/{cardId}

Pays an order with a saved card.

The order and the card must belong to the same customer.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/order/ordertransaction/savedcard/123
URI Parameters
HideShow
cardId
number (required) Example: 123
Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Response  200
HideShow

Returns the order transaction ID

Headers
Content-Type: application/json
Body
{
  "id": 43
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    }
  },
  "required": [
    "id"
  ]
}
Response  400
HideShow

Failed to pay the order

Headers
Content-Type: application/json
Body
{
  "error": "Rejected by acquirer",
  "errorCode": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Pay order with a payment method
POST/order/ordertransaction

Initiates the process of paying for an order with a payment card or other method supported by the Payment Service Provider.

The server will return a URL to the Payment Service Provider’s website where the customer can perform the payment.

When the payment is completed the customer’s browser is redirected to one of the URLs supplied in the request.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/order/ordertransaction
Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "successUrl": "http://example.com/success",
  "failedUrl": "http://example.com/argh",
  "paymentMethod": "creditcard",
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}
Schema
{
  "type": "object",
  "properties": {
    "successUrl": {
      "type": "string",
      "description": "URL to redirect to after succesful payment at the payment provider.\nIf this URL is the shop wait-page, it should include `order_number=<number>` from the response of `POST /order`."
    },
    "failedUrl": {
      "type": "string",
      "description": "URL for redirect when the registration fails."
    },
    "paymentMethod": {
      "type": "string",
      "description": "A Payment Service Provider specific string used to limit the possible payment methods.\n\nLinks to the PSPs' documentation:\n\n- [QuickPay](https://learn.quickpay.net/tech-talk/appendixes/payment-methods/)"
    },
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "successUrl",
    "failedUrl",
    "clientName"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow

This is the expected response. An amount remained to be payed and a new payment has been created. The newly created order transaction is returned.

Headers
Content-Type: application/json
Location: https://payment.quickpay.net/payments/96ff1de5be9a53eff51ea8bcfe12e553db697c7c67619efda4ca8d567d945535
Body
{
  "id": 43
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    }
  },
  "required": [
    "id"
  ]
}
Response  200
HideShow

This response is used when the order is fully paid - ie an order of free items or already paid. All order transactions from the order are returned

Headers
Content-Type: application/json
Body
[
  {
    "id": 43
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

product endpoints

Categories

Categories
GET/catalog/categories?languageCode={languageCode}

Returns a list of categories.

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/catalog/categories?languageCode=languageCode
URI Parameters
HideShow
languageCode
string (optional) Default: 'da' 

The language code for response, default is shop default language.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 8,
    "name": "Årskort",
    "label": "aarskort",
    "appData": {
      "header": "Årskort",
      "description": "Årskort til hele året",
      "image": "https://image.experimentarium.dk/media/catalog/product/cache/1/image/9df78eab33525d08d6e5fb8d27136e95/api/%C3%85rskort%20Senior.png"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Products

Products
GET/catalog/products/?languageCode={languageCode}&productType={productType}

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/catalog/products/?languageCode=languageCode&productType=productType
URI Parameters
HideShow
languageCode
string (optional) 

The language code for response, default is shop default language.

productType
string (optional) 

If supplied, find only products of this type

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 3,
    "name": "Årskort 2019",
    "label": "aarskort2019",
    "productType": "seasoncard",
    "priceInclVat": 685,
    "vat": 137,
    "currencyCode": "DKK",
    "hasInventoryPerDate": false,
    "appData": {
      "header": "Årskort",
      "description": "Årskort til hele året",
      "image": "https://image.experimentarium.dk/media/catalog/product/cache/1/image/9df78eab33525d08d6e5fb8d27136e95/api/%C3%85rskort%20Senior.png"
    },
    "properties": {
      "seasonCardIsBuyable": "1",
      "seasonCardIsRenewable": "0"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Product

Product
GET/catalog/product/?languageCode={languageCode}

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/catalog/product/?languageCode=languageCode
URI Parameters
HideShow
languageCode
string (optional) 

The language code for response, default is shop default language.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 3,
  "name": "Årskort 2019",
  "label": "aarskort2019",
  "productType": "seasoncard",
  "priceInclVat": 685,
  "vat": 137,
  "currencyCode": "DKK",
  "hasInventoryPerDate": false,
  "appData": {
    "header": "Årskort",
    "description": "Årskort til hele året",
    "image": "https://image.experimentarium.dk/media/catalog/product/cache/1/image/9df78eab33525d08d6e5fb8d27136e95/api/%C3%85rskort%20Senior.png"
  },
  "properties": {
    "seasonCardIsBuyable": "1",
    "seasonCardIsRenewable": "0"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "productType": {
      "type": "string"
    },
    "priceInclVat": {
      "type": "number"
    },
    "vat": {
      "type": "number"
    },
    "currencyCode": {
      "type": "string"
    },
    "hasInventoryPerDate": {
      "type": "boolean",
      "description": "If true, then a date must be selected when ordering this product"
    },
    "appData": {
      "type": "object",
      "properties": {
        "header": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "image": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "header",
        "description",
        "image"
      ]
    },
    "properties": {
      "type": "object",
      "properties": {
        "seasonCardIsBuyable": {
          "type": "string",
          "description": "Is the seasoncard buyable"
        },
        "seasonCardIsRenewable": {
          "type": "string",
          "description": "Is the product for renewing seasoncards"
        }
      }
    }
  },
  "required": [
    "id",
    "name",
    "label",
    "productType",
    "priceInclVat",
    "vat",
    "currencyCode",
    "hasInventoryPerDate"
  ]
}

Invoice endpoints

Invoices

Get invoices
GET/invoice?afterNumber={afterNumber}&limit={limit}&format={format}

Get a list of invoices, from after_number (excl.) and limit ahead.

Requires HTTP authentication (for an API-user in the shop).

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/invoice?afterNumber=65478&limit=10&format=xml
URI Parameters
HideShow
afterNumber
number (optional) Example: 65478
limit
number (optional) Example: 10
format
string (optional) Example: xml

Either json (default) or xml

Request
HideShow
Headers
Authorization: Basic ZnNfamNkOjEyM3Rlc3Q=
Response  200
HideShow

Returns an array of invoices in JSON format.

Headers
Content-Type: application/json
Body
[
  {
    "id": 12345,
    "number": 12345,
    "orderId": 12345,
    "type": "invoice",
    "date": "2019",
    "totalAmount": 4200.5,
    "totalDiscount": 0,
    "totalVat": 840.1,
    "currencyCode": "DKK",
    "customer": {
      "id": 1234,
      "number": "12341234",
      "name": "xyz",
      "street": "xyz",
      "company": "xyz",
      "zipCode": "xyz",
      "city": "xyz",
      "country": "xyz",
      "email": "xyz",
      "mobile": "xyz",
      "phone": "xyz"
    },
    "deliveryAddress": {
      "name": "xyz",
      "street": "xyz",
      "company": "xyz",
      "zipCode": "xyz",
      "city": "xyz",
      "country": "xyz"
    },
    "lines": [
      {
        "id": 1234,
        "type": "admission",
        "quantity": 2,
        "amount": 100,
        "discount": 50,
        "vatPercentage": 25,
        "totalAmount": 150,
        "sku": "XYZ",
        "numbers": [
          12340000,
          12340001
        ],
        "eventId": 123,
        "eventName": "Gryffindor - Slytherin",
        "seasonId": 3,
        "seasonName": "2019/2020"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  200
HideShow

Returns an array of invoices in XML format.

Headers
Content-Type: application/xml
Body
[
  {
    "id": 12345,
    "number": 12345,
    "orderId": 12345,
    "type": "invoice",
    "date": "2019",
    "totalAmount": 4200.5,
    "totalDiscount": 0,
    "totalVat": 840.1,
    "currencyCode": "DKK",
    "customer": {
      "id": 1234,
      "number": "12341234",
      "name": "xyz",
      "street": "xyz",
      "company": "xyz",
      "zipCode": "xyz",
      "city": "xyz",
      "country": "xyz",
      "email": "xyz",
      "mobile": "xyz",
      "phone": "xyz"
    },
    "deliveryAddress": {
      "name": "xyz",
      "street": "xyz",
      "company": "xyz",
      "zipCode": "xyz",
      "city": "xyz",
      "country": "xyz"
    },
    "lines": [
      {
        "id": 1234,
        "type": "admission",
        "quantity": 2,
        "amount": 100,
        "discount": 50,
        "vatPercentage": 25,
        "totalAmount": 150,
        "sku": "XYZ",
        "numbers": [
          12340000,
          12340001
        ],
        "eventId": 123,
        "eventName": "Gryffindor - Slytherin",
        "seasonId": 3,
        "seasonName": "2019/2020"
      }
    ]
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "description": "VM ID"
      },
      "number": {
        "type": "number",
        "description": "Unique identifier (used for the after_number in requests)"
      },
      "orderId": {
        "type": "number",
        "description": "VM ID"
      },
      "type": {
        "type": "string",
        "description": "Either 'invoice' or 'credit_note'"
      },
      "date": {
        "type": "string",
        "description": "01-17 (string, required)"
      },
      "totalAmount": {
        "type": "number",
        "description": "Includes both vat and discount"
      },
      "totalDiscount": {
        "type": "number",
        "description": "Includes vat"
      },
      "totalVat": {
        "type": "number"
      },
      "currencyCode": {
        "type": "string"
      },
      "customer": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "VM ID"
          },
          "number": {
            "type": "string",
            "description": "Address field (NAV customer number)"
          },
          "name": {
            "type": "string",
            "description": "Address field"
          },
          "street": {
            "type": "string",
            "description": "Address field"
          },
          "company": {
            "type": "string",
            "description": "Address field"
          },
          "zipCode": {
            "type": "string",
            "description": "Address field"
          },
          "city": {
            "type": "string",
            "description": "Address field"
          },
          "country": {
            "type": "string",
            "description": "Address field"
          },
          "email": {
            "type": "string",
            "description": "Address field"
          },
          "mobile": {
            "type": "string",
            "description": "Address field"
          },
          "phone": {
            "type": "string",
            "description": "Address field"
          }
        },
        "required": [
          "id"
        ]
      },
      "deliveryAddress": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Address field"
          },
          "street": {
            "type": "string",
            "description": "Address field"
          },
          "company": {
            "type": "string",
            "description": "Address field"
          },
          "zipCode": {
            "type": "string",
            "description": "Address field"
          },
          "city": {
            "type": "string",
            "description": "Address field"
          },
          "country": {
            "type": "string",
            "description": "Address field"
          }
        }
      },
      "lines": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "VM ID"
            },
            "type": {
              "type": "string"
            },
            "quantity": {
              "type": "number"
            },
            "amount": {
              "type": "number",
              "description": "Price per pcs, includes vat"
            },
            "discount": {
              "type": "number",
              "description": "Discount for the whole line, includes vat"
            },
            "vatPercentage": {
              "type": "number"
            },
            "totalAmount": {
              "type": "number",
              "description": "Total price for the whole line (quantity * amount - discount)"
            },
            "sku": {
              "type": "string",
              "description": "NAV SKU"
            },
            "numbers": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "Ticket or Season card \"IDs\""
            },
            "eventId": {
              "type": "number",
              "description": "ID of the event for the ticket"
            },
            "eventName": {
              "type": "string",
              "description": "Name of the event for the ticket"
            },
            "seasonId": {
              "type": "number",
              "description": "ID of the season for the ticket event og season ticket"
            },
            "seasonName": {
              "type": "string",
              "description": "Name of the season for the ticket event or season ticket"
            }
          },
          "required": [
            "id",
            "type",
            "quantity",
            "amount",
            "discount",
            "vatPercentage",
            "totalAmount"
          ]
        }
      }
    },
    "required": [
      "id",
      "number",
      "orderId",
      "type",
      "totalAmount",
      "totalDiscount",
      "totalVat",
      "currencyCode",
      "customer",
      "lines"
    ]
  },
  "description": "<invoices>\n  <invoice>\n    <id>12345</id>\n    <number>12345</number>\n    <orderId>12345</orderId>\n    <type>invoice</type>\n    <date>2019-01-17</date>\n    <totalAmount>4200.5</totalAmount>\n    <totalDiscount>0.0</totalDiscount>\n    <totalVat>840.1</totalVat>\n    <currencyCode>DKK</currencyCode>\n    <customer>\n      <id>1234</id>\n      <number>12341234</number>\n      <name>xyz</name>\n      <street>xyz</street>\n      <company>xyz</company>\n      <zipCode>xyz</zipCode>\n      <city>xyz</city>\n      <country>xyz</country>\n      <email>xyz</email>\n      <mobile>xyz</mobile>\n      <phone>xyz</phone>\n    </customer>\n    <deliveryAddress>\n      <name>xyz</name>\n      <street>xyz</street>\n      <company>xyz</company>\n      <zipCode>xyz</zipCode>\n      <city>xyz</city>\n      <country>xyz</country>\n    </deliveryAddress>\n    <lines>\n      <line>\n        <id>1234</id>\n        <type>admission</type>\n        <quantity>2</quantity>\n        <amount>100.0</amount>\n        <discount>50.0</discount>\n        <vatPercentage>25.0</vatPercentage>\n        <totalAmount>150.0</totalAmount>\n        <sku>XYZ</sku>\n        <numbers>\n          <number>123450000</number>\n          <number>123450001</number>\n        </numbers>\n      </line>\n      <line>\n        <id>1234</id>\n        <type>seasonCard</type>\n        <quantity>1</quantity>\n        <amount>800.0</amount>\n        <discount>0.0</discount>\n        <vatPercentage>25.0</vatPercentage>\n        <totalAmount>800.0</totalAmount>\n        <sku>XYZ</sku>\n        <numbers>\n          <number>12346</number>\n        </numbers>\n      </line>\n      <line>\n        <id>1234</id>\n        <type>product</type>\n        <quantity>2</quantity>\n        <amount>20.0</amount>\n        <discount>0.0</discount>\n        <vatPercentage>25.0</vatPercentage>\n        <totalAmount>40.0</totalAmount>\n        <sku>XYZ</sku>\n      </line>\n    </lines>\n  </invoice>\n</invoices>",
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow

format is not valid. Must be json or xml.

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  401
HideShow

Unauthorized.

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

afterNumber is not a known invoice.

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Invoice payment status

Mark invoice as paid
PUT/invoice/markAsPaidByExternalId/{externalId}

Marks the invoice as paid.

Requires HTTP authentication (for an API-user in the shop).

Example URI

PUT https://{customer}.admin.venuemanager.net/api/core/invoice/markAsPaidByExternalId/DG817
URI Parameters
HideShow
externalId
string (required) Example: DG817

The external ID returned when the invoice was exported.

Request
HideShow
Headers
Authorization: Basic ZnNfamNkOjEyM3Rlc3Q=
Response  204
Response  401
HideShow

Unauthorized.

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

The supplied externalId is not known.

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  406
HideShow

The supplied externalId does not uniquely identify an invoice.

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Loyalty endpoints

Loyalty barcodes

Register usage

Register usage
POST/loyalty/barcode/registerUsage

Register usage of a loyalty barcode.

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/loyalty/barcode/registerUsage
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Body
{
  "clientName": "VenueApp",
  "clientOs": "iPhone - iOS - 12.0",
  "code": "XYZ1234"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "description": "The code to register"
    }
  },
  "required": [
    "clientName",
    "clientOs",
    "code"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "points": 12
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "points": {
      "type": "number",
      "description": "Number of points given for usage."
    }
  },
  "required": [
    "points"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Argument \"code\" missing or empty.",
  "errorCode": 1984
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}
Response  403
HideShow

Can be one of the following errors: 1001: Loyalty barcode no longer valid 1002: Loyalty barcode already used

Headers
Content-Type: application/json
Body
{
  "error": "Loyalty barcode no longer valid",
  "errorCode": "1001"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "string",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": "Unknown loyalty barcode: XYZ1234",
  "errorCode": "1000"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "string",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Voucher endpoints

Voucher codes

Get voucher code

Get voucher code
GET/voucher/code?code=

Get info about a voucher code, by its code value

Example URI

GET https://{customer}.admin.venuemanager.net/api/core/voucher/code?code=
Request
HideShow
Headers
Content-Type: application/json or application/xml
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Response  200
HideShow
Body
{
  "id": 123,
  "voucherId": 120,
  "code": "XYZ1234",
  "isValid": true,
  "message": "Rabatkoden er allerede brugt",
  "creationPrice": {
    "amount": 100,
    "discount": 0,
    "vatPercentage": 25,
    "currencyCode": "DKK"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "VM ID for the code (used for redeeming)"
    },
    "voucherId": {
      "type": "number",
      "description": "VM ID for the voucher"
    },
    "code": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "message": {
      "type": "string",
      "description": "Error message if the voucher code isn't valid"
    },
    "creationPrice": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number",
          "description": "Price, including VAT"
        },
        "discount": {
          "type": "number",
          "description": "Discount given on the line, including VAT"
        },
        "vatPercentage": {
          "type": "number"
        },
        "currencyCode": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "discount",
        "vatPercentage",
        "currencyCode"
      ],
      "description": "Price if the code were created by buying a product"
    }
  },
  "required": [
    "id",
    "voucherId",
    "code",
    "isValid"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  400
HideShow

Missing voucher code value

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

Unknown voucher code

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Redeem voucher code

Redeem voucher code
POST/voucher/code/redeem

Redeem a voucher without an order (set it as used).

Example URI

POST https://{customer}.admin.venuemanager.net/api/core/voucher/code/redeem
Request
HideShow
Headers
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.zX9FNzX3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILHX5w
Response  204
Response  400
HideShow

Missing voucher code ID

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  403
HideShow

Voucher code already redeemed

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

Unknown voucher code

Body
{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}
Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Generated by aglio on 20 Feb 2024