Base URL

https://api.venuerun.com/merchants/:merchantId/tags

Tags

Tags are used to define location identifiers for contactless ordering.

This doc was generated by our interal API tester at:

November 11, 2024 at 11:51:30 AM

Endpoints

GET /merchants/:merchantId/tags
GET /merchants/:merchantId/tags/:tagId
POST /merchants/:merchantId/products
POST /merchants/:merchantId/tags/:tagId
DELETE /merchants/:merchantId/tags/:tagId

The Tag Object

Properties

Name
id
Type
string read-only
Description
The id of the tag
Name
nfc
Type
boolean
Description
If the tag is an NFC tag this will be set to true when a tag is activated via NFC.
Name
metadata
Type
array
Description
Meta data to define location identifiers
Name
object
Type
object
Description
Object with keys and values
Name
key
Type
string
Description
The key of the metadata
Name
value
Type
string
Description
The value of the metadata
Name
visible
Type
boolean
Description
Is the metadata visible to customer on ordering pages.
Name
createdAt
Type
string read-only
Description
The date the object was created
Name
updatedAt
Type
string read-only
Description
The date the object was updated
Name
testMode
Type
boolean
Description
Is the tag in test mode, will redirect to sandbox URL.

The Tag Object

[
  {
    "id": "cJxIVQ6Jml14suSM1l2A",
    "message": "Table 1",
    "qrUrl": "https://venuerun.com/qr/cJxIVQ6Jml14suSM1l2A",
    "url": "https:/.venuerun.com/tag/cJxIVQ6Jml14suSM1l2A",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "1",
        "visible": true
      }
    ],
    "nfc": false,
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 675000000,
      "_seconds": 1722301773
    },
    "updatedAt": 1727730816
  },
  {
    "id": "BuxX39KyZYyEp2jyraZ6",
    "message": "Table 2",
    "qrUrl": "https://venuerun.com/qr/BuxX39KyZYyEp2jyraZ6",
    "url": "https:/.venuerun.com/tag/BuxX39KyZYyEp2jyraZ6",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "2",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 756000000,
      "_seconds": 1722301773
    }
  },
  {
    "id": "Uef2wuCiniPWYYRqglsD",
    "message": "Table 3",
    "qrUrl": "https://venuerun.com/qr/Uef2wuCiniPWYYRqglsD",
    "url": "https:/.venuerun.com/tag/Uef2wuCiniPWYYRqglsD",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "3",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 827000000,
      "_seconds": 1722301773
    }
  },
  {
    "id": "Sl9D5uIiXkwiDErKB9Nt",
    "message": "Table 4",
    "qrUrl": "https://venuerun.com/qr/Sl9D5uIiXkwiDErKB9Nt",
    "url": "https:/.venuerun.com/tag/Sl9D5uIiXkwiDErKB9Nt",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "4",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 913000000,
      "_seconds": 1722301773
    }
  },
  {
    "id": "a1eUHM1uzqBMzp40qSJG",
    "message": "Table 5",
    "qrUrl": "https://venuerun.com/qr/a1eUHM1uzqBMzp40qSJG",
    "url": "https:/.venuerun.com/tag/a1eUHM1uzqBMzp40qSJG",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "5",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 33000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "WfeUufSpzQzjaPVZU8iX",
    "message": "Table 6",
    "qrUrl": "https://venuerun.com/qr/WfeUufSpzQzjaPVZU8iX",
    "url": "https:/.venuerun.com/tag/WfeUufSpzQzjaPVZU8iX",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "6",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 121000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "lpAwmkVAzbVVJS1TxQ46",
    "message": "Table 7",
    "qrUrl": "https://venuerun.com/qr/lpAwmkVAzbVVJS1TxQ46",
    "url": "https:/.venuerun.com/tag/lpAwmkVAzbVVJS1TxQ46",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "7",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 210000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "7K2rYx8BoFHBtOjxMyjo",
    "message": "Table 8",
    "qrUrl": "https://venuerun.com/qr/7K2rYx8BoFHBtOjxMyjo",
    "url": "https:/.venuerun.com/tag/7K2rYx8BoFHBtOjxMyjo",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "8",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 304000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "iJ8BFfSI9yWJCJptO0Fs",
    "message": "Table 9",
    "qrUrl": "https://venuerun.com/qr/iJ8BFfSI9yWJCJptO0Fs",
    "url": "https:/.venuerun.com/tag/iJ8BFfSI9yWJCJptO0Fs",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "9",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 408000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "luqMixiDmropXBKZs8Yv",
    "message": "Table 10",
    "qrUrl": "https://venuerun.com/qr/luqMixiDmropXBKZs8Yv",
    "url": "https:/.venuerun.com/tag/luqMixiDmropXBKZs8Yv",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "10",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 491000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "ztqVUcpn4iUNeZepwv4P",
    "message": "Table 11",
    "qrUrl": "https://venuerun.com/qr/ztqVUcpn4iUNeZepwv4P",
    "url": "https:/.venuerun.com/tag/ztqVUcpn4iUNeZepwv4P",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "11",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 568000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "3PSRBiHYE9Fsq3fXgm4N",
    "message": "Table 12",
    "qrUrl": "https://venuerun.com/qr/3PSRBiHYE9Fsq3fXgm4N",
    "url": "https:/.venuerun.com/tag/3PSRBiHYE9Fsq3fXgm4N",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "12",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": false,
    "timestamp": {
      "_nanoseconds": 689000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "XS0yA5wLVLkF51JBIcYd",
    "message": "Table 13",
    "qrUrl": "https://venuerun.com/qr/XS0yA5wLVLkF51JBIcYd",
    "url": "https:/.venuerun.com/tag/XS0yA5wLVLkF51JBIcYd",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "13",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 781000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "VVGT5YYVHl4VsFf1w24w",
    "message": "Table 14",
    "qrUrl": "https://venuerun.com/qr/VVGT5YYVHl4VsFf1w24w",
    "url": "https:/.venuerun.com/tag/VVGT5YYVHl4VsFf1w24w",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "14",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 863000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "xFggPebZg4l56rN5U88c",
    "message": "Table 15",
    "qrUrl": "https://venuerun.com/qr/xFggPebZg4l56rN5U88c",
    "url": "https:/.venuerun.com/tag/xFggPebZg4l56rN5U88c",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "15",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 973000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "eG8YUYXoKUEA3VGMDlEN",
    "message": "Table 16",
    "qrUrl": "https://venuerun.com/qr/eG8YUYXoKUEA3VGMDlEN",
    "url": "https:/.venuerun.com/tag/eG8YUYXoKUEA3VGMDlEN",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "16",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 47000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "sxkPFwRqstg44UyPXxEq",
    "message": "Table 17",
    "qrUrl": "https://venuerun.com/qr/sxkPFwRqstg44UyPXxEq",
    "url": "https:/.venuerun.com/tag/sxkPFwRqstg44UyPXxEq",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "17",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 136000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "rzA2fneVCADYUMFCtJy4",
    "message": "Table 18",
    "qrUrl": "https://venuerun.com/qr/rzA2fneVCADYUMFCtJy4",
    "url": "https:/.venuerun.com/tag/rzA2fneVCADYUMFCtJy4",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "18",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 214000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "Mf7XHa9OKttSnbFsF0Jh",
    "message": "Table 19",
    "qrUrl": "https://venuerun.com/qr/Mf7XHa9OKttSnbFsF0Jh",
    "url": "https:/.venuerun.com/tag/Mf7XHa9OKttSnbFsF0Jh",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "19",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 310000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "u7nuYUKVmXcDLEycgcLk",
    "message": "Table 20",
    "qrUrl": "https://venuerun.com/qr/u7nuYUKVmXcDLEycgcLk",
    "url": "https:/.venuerun.com/tag/u7nuYUKVmXcDLEycgcLk",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "20",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 384000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "tZ1k66wgojvfhHqrOqf8",
    "message": "Table 99",
    "qrUrl": "https://venuerun.com/qr/tZ1k66wgojvfhHqrOqf8",
    "url": "https:/.venuerun.com/tag/tZ1k66wgojvfhHqrOqf8",
    "createdAt": 1731347487,
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "metadata": [
      {
        "key": "Table",
        "value": "99",
        "visible": true
      }
    ],
    "nfc": false,
    "testMode": false,
    "updatedAt": 1731347487
  }
]

POST/merchants/:merchantId/tags

Create a Tag

This endpoint allows you to create a Tag

Required attributes

Optional attributes

Name
id
Type
string read-only
Description
The id of the tag
Name
nfc
Type
boolean
Description
If the tag is an NFC tag this will be set to true when a tag is activated via NFC.
Name
metadata
Type
array
Description
Meta data to define location identifiers
Name
object
Type
object
Description
Object with keys and values
Name
key
Type
string
Description
The key of the metadata
Name
value
Type
string
Description
The value of the metadata
Name
visible
Type
boolean
Description
Is the metadata visible to customer on ordering pages.
Name
createdAt
Type
string read-only
Description
The date the object was created
Name
updatedAt
Type
string read-only
Description
The date the object was updated
Name
testMode
Type
boolean
Description
Is the tag in test mode, will redirect to sandbox URL.

Request

POST

/merchants/:merchantsId/tags

const tag = await VenueRun.tags.create({
  metadata: [{
      key: "Table",
      value: "1"
    }]
});

POST/merchants/:merchantId/tags/:tagId

Update a tag

This endpoint allows you to update a Tag

Required parameters

Name
id
Type
string
Description
id of the tags

Optional attributes

Name
id
Type
string read-only
Description
The id of the tag
Name
nfc
Type
boolean
Description
If the tag is an NFC tag this will be set to true when a tag is activated via NFC.
Name
metadata
Type
array
Description
Meta data to define location identifiers
Name
object
Type
object
Description
Object with keys and values
Name
key
Type
string
Description
The key of the metadata
Name
value
Type
string
Description
The value of the metadata
Name
visible
Type
boolean
Description
Is the metadata visible to customer on ordering pages.
Name
createdAt
Type
string read-only
Description
The date the object was created
Name
updatedAt
Type
string read-only
Description
The date the object was updated
Name
testMode
Type
boolean
Description
Is the tag in test mode, will redirect to sandbox URL.

Request

POST

/merchants/:merchantsId/tags/tagId

await VenueRun.tags.update(tagId, {
  metadata: [{
      key: "Table",
      value: "99"
    }]
});

Response

{
  "createdAt": 1731347487,
  "documentCollection": "merchants",
  "documentId": "054q775dzyX0nr8Q6bA6",
  "id": "tZ1k66wgojvfhHqrOqf8",
  "metadata": [
    {
      "key": "Table",
      "value": "99",
      "visible": true
    }
  ],
  "nfc": false,
  "testMode": false,
  "updatedAt": 1731347487
}

GET/merchants/:merchantId/tags/:tagId

Retrive a Tag

This endpoint allows you to retrieve a Tag

Required parameters

Name
id
Type
string
Description
id of the Tag

Request

GET

/merchants/:merchantsId/tags/:tagId

const product = await VenueRun.tags.retrieve(product.id);

Response

[
  {
    "id": "cJxIVQ6Jml14suSM1l2A",
    "message": "Table 1",
    "qrUrl": "https://venuerun.com/qr/cJxIVQ6Jml14suSM1l2A",
    "url": "https:/.venuerun.com/tag/cJxIVQ6Jml14suSM1l2A",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "1",
        "visible": true
      }
    ],
    "nfc": false,
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 675000000,
      "_seconds": 1722301773
    },
    "updatedAt": 1727730816
  },
  {
    "id": "BuxX39KyZYyEp2jyraZ6",
    "message": "Table 2",
    "qrUrl": "https://venuerun.com/qr/BuxX39KyZYyEp2jyraZ6",
    "url": "https:/.venuerun.com/tag/BuxX39KyZYyEp2jyraZ6",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "2",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 756000000,
      "_seconds": 1722301773
    }
  },
  {
    "id": "Uef2wuCiniPWYYRqglsD",
    "message": "Table 3",
    "qrUrl": "https://venuerun.com/qr/Uef2wuCiniPWYYRqglsD",
    "url": "https:/.venuerun.com/tag/Uef2wuCiniPWYYRqglsD",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "3",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 827000000,
      "_seconds": 1722301773
    }
  },
  {
    "id": "Sl9D5uIiXkwiDErKB9Nt",
    "message": "Table 4",
    "qrUrl": "https://venuerun.com/qr/Sl9D5uIiXkwiDErKB9Nt",
    "url": "https:/.venuerun.com/tag/Sl9D5uIiXkwiDErKB9Nt",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "4",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 913000000,
      "_seconds": 1722301773
    }
  },
  {
    "id": "a1eUHM1uzqBMzp40qSJG",
    "message": "Table 5",
    "qrUrl": "https://venuerun.com/qr/a1eUHM1uzqBMzp40qSJG",
    "url": "https:/.venuerun.com/tag/a1eUHM1uzqBMzp40qSJG",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "5",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 33000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "WfeUufSpzQzjaPVZU8iX",
    "message": "Table 6",
    "qrUrl": "https://venuerun.com/qr/WfeUufSpzQzjaPVZU8iX",
    "url": "https:/.venuerun.com/tag/WfeUufSpzQzjaPVZU8iX",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "6",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 121000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "lpAwmkVAzbVVJS1TxQ46",
    "message": "Table 7",
    "qrUrl": "https://venuerun.com/qr/lpAwmkVAzbVVJS1TxQ46",
    "url": "https:/.venuerun.com/tag/lpAwmkVAzbVVJS1TxQ46",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "7",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 210000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "7K2rYx8BoFHBtOjxMyjo",
    "message": "Table 8",
    "qrUrl": "https://venuerun.com/qr/7K2rYx8BoFHBtOjxMyjo",
    "url": "https:/.venuerun.com/tag/7K2rYx8BoFHBtOjxMyjo",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "8",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 304000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "iJ8BFfSI9yWJCJptO0Fs",
    "message": "Table 9",
    "qrUrl": "https://venuerun.com/qr/iJ8BFfSI9yWJCJptO0Fs",
    "url": "https:/.venuerun.com/tag/iJ8BFfSI9yWJCJptO0Fs",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "9",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 408000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "luqMixiDmropXBKZs8Yv",
    "message": "Table 10",
    "qrUrl": "https://venuerun.com/qr/luqMixiDmropXBKZs8Yv",
    "url": "https:/.venuerun.com/tag/luqMixiDmropXBKZs8Yv",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "10",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 491000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "ztqVUcpn4iUNeZepwv4P",
    "message": "Table 11",
    "qrUrl": "https://venuerun.com/qr/ztqVUcpn4iUNeZepwv4P",
    "url": "https:/.venuerun.com/tag/ztqVUcpn4iUNeZepwv4P",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "11",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 568000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "3PSRBiHYE9Fsq3fXgm4N",
    "message": "Table 12",
    "qrUrl": "https://venuerun.com/qr/3PSRBiHYE9Fsq3fXgm4N",
    "url": "https:/.venuerun.com/tag/3PSRBiHYE9Fsq3fXgm4N",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "12",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": false,
    "timestamp": {
      "_nanoseconds": 689000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "XS0yA5wLVLkF51JBIcYd",
    "message": "Table 13",
    "qrUrl": "https://venuerun.com/qr/XS0yA5wLVLkF51JBIcYd",
    "url": "https:/.venuerun.com/tag/XS0yA5wLVLkF51JBIcYd",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "13",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 781000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "VVGT5YYVHl4VsFf1w24w",
    "message": "Table 14",
    "qrUrl": "https://venuerun.com/qr/VVGT5YYVHl4VsFf1w24w",
    "url": "https:/.venuerun.com/tag/VVGT5YYVHl4VsFf1w24w",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "14",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 863000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "xFggPebZg4l56rN5U88c",
    "message": "Table 15",
    "qrUrl": "https://venuerun.com/qr/xFggPebZg4l56rN5U88c",
    "url": "https:/.venuerun.com/tag/xFggPebZg4l56rN5U88c",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "15",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 973000000,
      "_seconds": 1722301774
    }
  },
  {
    "id": "eG8YUYXoKUEA3VGMDlEN",
    "message": "Table 16",
    "qrUrl": "https://venuerun.com/qr/eG8YUYXoKUEA3VGMDlEN",
    "url": "https:/.venuerun.com/tag/eG8YUYXoKUEA3VGMDlEN",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "16",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 47000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "sxkPFwRqstg44UyPXxEq",
    "message": "Table 17",
    "qrUrl": "https://venuerun.com/qr/sxkPFwRqstg44UyPXxEq",
    "url": "https:/.venuerun.com/tag/sxkPFwRqstg44UyPXxEq",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "17",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 136000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "rzA2fneVCADYUMFCtJy4",
    "message": "Table 18",
    "qrUrl": "https://venuerun.com/qr/rzA2fneVCADYUMFCtJy4",
    "url": "https:/.venuerun.com/tag/rzA2fneVCADYUMFCtJy4",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "18",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 214000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "Mf7XHa9OKttSnbFsF0Jh",
    "message": "Table 19",
    "qrUrl": "https://venuerun.com/qr/Mf7XHa9OKttSnbFsF0Jh",
    "url": "https:/.venuerun.com/tag/Mf7XHa9OKttSnbFsF0Jh",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "19",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 310000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "u7nuYUKVmXcDLEycgcLk",
    "message": "Table 20",
    "qrUrl": "https://venuerun.com/qr/u7nuYUKVmXcDLEycgcLk",
    "url": "https:/.venuerun.com/tag/u7nuYUKVmXcDLEycgcLk",
    "alias": [],
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "edited": false,
    "metadata": [
      {
        "key": "Table",
        "value": "20",
        "visible": true
      }
    ],
    "qr": true,
    "testMode": true,
    "timestamp": {
      "_nanoseconds": 384000000,
      "_seconds": 1722301775
    }
  },
  {
    "id": "tZ1k66wgojvfhHqrOqf8",
    "message": "Table 99",
    "qrUrl": "https://venuerun.com/qr/tZ1k66wgojvfhHqrOqf8",
    "url": "https:/.venuerun.com/tag/tZ1k66wgojvfhHqrOqf8",
    "createdAt": 1731347487,
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "metadata": [
      {
        "key": "Table",
        "value": "99",
        "visible": true
      }
    ],
    "nfc": false,
    "testMode": false,
    "updatedAt": 1731347487
  }
]

DELETE/merchants/:merchantId/tags/:tagId

Delete a tag

This endpoint allows you to delete a Tag

Required parameters

Name
id
Type
string
Description
id of the product

Request

POST

/merchants/:merchantsId/tags/:tagId

await VenueRun.tags.delete(tagId);

Response

{
  "id": "tZ1k66wgojvfhHqrOqf8",
  "object": {
    "createdAt": 1731347487,
    "documentCollection": "merchants",
    "documentId": "054q775dzyX0nr8Q6bA6",
    "id": "tZ1k66wgojvfhHqrOqf8",
    "metadata": [
      {
        "key": "Table",
        "value": "99",
        "visible": true
      }
    ],
    "nfc": false,
    "testMode": false,
    "updatedAt": 1731347487
  },
  "message": "Tag deleted",
  "deleted": true
}

GET/merchants/:merchantId/tags

Get all Tags

This endpoint allows you to list all Tags

Request

POST

/merchants/:merchantsId/tags

await VenueRun.tags.list()