Back to top

Venue Manager shop API - DigitalProduct

Digital Product specific endpoints for the Venue Manager shop platform.

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

Et simpelt REST-interface hvor Tulle kan kommunikere med shopløsningen fra Venue Manager.

Resource Group

Digitale produkter

Søg efter kunder og deres produkter
GET/products{?name,company,street,email,customerId,orderId,tokenUid,barcode,quick_search,festiwebPersonId}

Mindst ét søge-kriterie skal udfyldes.

Example URI

GET https://{customer}.admin.venuemanager.net/api/digital_product/products?name=Rakel * Hovn&company=Combine *&street=Dannebrogsgade *&email=rah@combine.dk&customerId=76529&orderId=76529&tokenUid=8768765876875&barcode=000109028100000164&quick_search=Rakel Combine&festiwebPersonId=76529
URI Parameters
HideShow
name
string (optional) Example: Rakel * Hovn

* er tilladt som joker.

company
string (optional) Example: Combine *

* er tilladt som joker.

street
string (optional) Example: Dannebrogsgade *

Kun sammen med name eller company. * er tilladt som joker.

email
string (optional) Example: rah@combine.dk
customerId
number (optional) Example: 76529
orderId
number (optional) Example: 76529
tokenUid
string (optional) Example: 8768765876875
barcode
string (optional) Example: 000109028100000164
quick_search
string (optional) Example: Rakel Combine

Søgning på tværs af alle felter. Kun for Sphinx søgning.

festiwebPersonId
number (optional) Example: 76529
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 38081,
    "address": {
      "name": "Rakel Hovn",
      "company": "Combine A/S",
      "street": "Dannebrogsgade 58A, 2.",
      "zipCode": "9000",
      "city": "Aalborg",
      "countryCode": "DK",
      "email": "rah@combine.dk",
      "phone": "+45 20781206"
    },
    "orders": [
      {
        "id": 76529,
        "authorizedTime": "2015-12-15 08:53:36",
        "billingAddress": {
          "name": "Rakel Hovn",
          "company": "Combine A/S",
          "street": "Dannebrogsgade 58A, 2.",
          "zipCode": "9000",
          "city": "Aalborg",
          "countryCode": "DK",
          "email": "rah@combine.dk",
          "phone": "+45 20781206"
        },
        "deliveryAddress": {
          "name": "Rakel Hovn",
          "company": "Combine A/S",
          "street": "Dannebrogsgade 58A, 2.",
          "zipCode": "9000",
          "city": "Aalborg",
          "countryCode": "DK"
        },
        "digitalProducts": [
          {
            "id": 457,
            "name": "Lørdagsarmbånd",
            "invalidateTime": "null",
            "productImageUrl": "https://placecats.com/300/200",
            "barcode": "000109028100000164",
            "alias": "'Walthers armbånd'",
            "tokens": [
              {
                "uid": "8768765876875",
                "insertTime": "2015-12-15 08:53:36",
                "invalidateTime": "null"
              }
            ],
            "events": [
              {
                "time": "2015-12-15 08:53:36",
                "type": "general",
                "description": "Købt"
              }
            ]
          }
        ]
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
        error: "No arguments specified"
    }

Historik for et digitalt produkt
GET/products/{digitalProductId}

Returnerer en komplet historik for det digitale produkt, herunder alle overdragelser etc.

Example URI

GET https://{customer}.admin.venuemanager.net/api/digital_product/products/457
URI Parameters
HideShow
digitalProductId
number (required) Example: 457

The digital product we want information for.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "digitalProductId": 457,
  "name": "Lørdagsarmbånd",
  "alias": "'Walthers armbånd'",
  "invalidateTime": "null",
  "orders": [
    {
      "id": 76529,
      "authorizedTime": "2015-12-15 08:53:36",
      "billingAddress": {
        "name": "Rakel Hovn",
        "company": "Combine A/S",
        "street": "Dannebrogsgade 58A, 2.",
        "zipCode": "9000",
        "city": "Aalborg",
        "countryCode": "DK",
        "email": "rah@combine.dk",
        "phone": "+45 20781206"
      },
      "deliveryAddress": {
        "name": "Rakel Hovn",
        "company": "Combine A/S",
        "street": "Dannebrogsgade 58A, 2.",
        "zipCode": "9000",
        "city": "Aalborg",
        "countryCode": "DK"
      },
      "digitalProducts": [
        {
          "id": 457,
          "name": "Lørdagsarmbånd",
          "invalidateTime": "null",
          "productImageUrl": "https://placecats.com/300/200",
          "barcode": "000109028100000164",
          "alias": "'Walthers armbånd'",
          "tokens": [
            {
              "uid": "8768765876875",
              "insertTime": "2015-12-15 08:53:36",
              "invalidateTime": "null"
            }
          ],
          "events": [
            {
              "time": "2015-12-15 08:53:36",
              "type": "general",
              "description": "Købt"
            }
          ]
        }
      ],
      "customerId": 38081,
      "CustomerAddress": {
        "name": "Rakel Hovn",
        "company": "Combine A/S",
        "street": "Dannebrogsgade 58A, 2.",
        "zipCode": "9000",
        "city": "Aalborg",
        "countryCode": "DK",
        "email": "rah@combine.dk",
        "phone": "+45 20781206"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "digitalProductId": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "alias": {
      "type": "string"
    },
    "invalidateTime": {
      "type": "string",
      "description": "null if valid"
    },
    "orders": {
      "type": "array"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown digital product ID."
    }

Tilføj kommentar
POST/products/{digitalProductId}/comment

Tilføjer en intern kommentar til et aktivt digitalt produkt.

Example URI

POST https://{customer}.admin.venuemanager.net/api/digital_product/products/457/comment
URI Parameters
HideShow
digitalProductId
number (required) Example: 457
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "comment": "Customer is rude and has received final warning."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "comment": {
      "type": "string"
    }
  },
  "required": [
    "comment"
  ]
}
Response  204
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown digital product ID."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "No empty comments!"
    }

Blokér token
DELETE/products/{digitalProductId}/tokens/{uid}]

Spærrer et armbånd.

Example URI

DELETE https://{customer}.admin.venuemanager.net/api/digital_product/products/457/tokens/8768765876875]
URI Parameters
HideShow
digitalProductId
number (required) Example: 457

The digital product the token belongs to.

uid
string (required) Example: 8768765876875

The token UID to block.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "reason": "Card reported stolen."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Description of the reason for the action."
    }
  }
}
Response  204
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Specified token UID is already blocked on the digital product."
    }
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown digital product ID."
    }
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown token UID for the digital product."
    }

Tilføj token
POST/products/{digitalProductId}/tokens{?uid}

Tilknytter et armbånd til et digitalt produkt.

Parameter digitalProductId skal benyttes for at udpege det digitale produkt.

Example URI

POST https://{customer}.admin.venuemanager.net/api/digital_product/products/457/tokens?uid=8768765876875
URI Parameters
HideShow
digitalProductId
number (required) Example: 457
uid
string (required) Example: 8768765876875

The token UID to add.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "reason": "Print@Home ticket replaced with chip"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Description of the reason for the action."
    }
  }
}
Response  204
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "No UID specified."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "The digital product is invalidated."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "The digital product already has an active token."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Token is active on another digital product."
    }
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown digital product ID."
    }

Erstat token
PUT/products/{digitalProductId}/tokens/{uid}{?newUid}

Erstatter et aktivt armbånd med et andet.

Example URI

PUT https://{customer}.admin.venuemanager.net/api/digital_product/products/457/tokens/8768765876875?newUid=8768765876876
URI Parameters
HideShow
digitalProductId
number (required) Example: 457
uid
string (required) Example: 8768765876875

The token to block.

newUid
string (required) Example: 8768765876876

The token to add.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "reason": "Chip cannot be read by scanners"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "description": "Description of the reason for the action."
    }
  }
}
Response  204
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "No newUid specified."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "The digital product is invalidated."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Specified token UID is already blocked on the digital product."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "The digital product has more than one active token."
    }
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
        error: "New token is active on another digital product."
    }
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown digital product ID."
    }
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
        error: "Unknown token UID for the digital product."
    }

Generated by aglio on 16 Jan 2025