PUT api/v2/tags

Report a list of tag observations. Use this API to group a list of tag observations by events or simply to reduce network traffic. Only "checkout" or "inventory" intent is supported.

Request Information

URI Parameters

None.

Body Parameters

TagList
NameDescriptionTypeAdditional information
intent

TagDisposition

None.

tags

Tags collections

Collection of Tag

None.

Request Formats

application/xml, text/xml

Sample:
<tags xmlns="urn:tagvue:am">
  <intent>unknown</intent>
  <tag entity-id="sample string 2">
    <status>inactive</status>
    <last-seen-time>2025-05-30T19:11:20.5144672-07:00</last-seen-time>
    <last-seen-location entity-id="sample string 2">
      <name>sample string 1</name>
    </last-seen-location>
    <moved-from-location entity-id="sample string 2">
      <name>sample string 1</name>
    </moved-from-location>
    <disposition>unknown</disposition>
    <latitude>1.1</latitude>
    <longitude>1.1</longitude>
    <last-seen-provider>1</last-seen-provider>
    <last-seen-x-coordinate>1.1</last-seen-x-coordinate>
    <BatteryLevel>1</BatteryLevel>
    <last-seen-y-coordinate>1.1</last-seen-y-coordinate>
  </tag>
  <tag entity-id="sample string 2">
    <status>inactive</status>
    <last-seen-time>2025-05-30T19:11:20.5144672-07:00</last-seen-time>
    <last-seen-location entity-id="sample string 2">
      <name>sample string 1</name>
    </last-seen-location>
    <moved-from-location entity-id="sample string 2">
      <name>sample string 1</name>
    </moved-from-location>
    <disposition>unknown</disposition>
    <latitude>1.1</latitude>
    <longitude>1.1</longitude>
    <last-seen-provider>1</last-seen-provider>
    <last-seen-x-coordinate>1.1</last-seen-x-coordinate>
    <BatteryLevel>1</BatteryLevel>
    <last-seen-y-coordinate>1.1</last-seen-y-coordinate>
  </tag>
</tags>

application/json, text/json

Sample:
{
  "intent": 0,
  "tags": [
    {
      "last-seen-time": "2025-05-30T19:11:20.5144672-07:00",
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "moved-from-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "disposition": 0,
      "latitude": 1.1,
      "longitude": 1.1,
      "last-seen-provider": 1,
      "last-seen-x-coordinate": 1.1,
      "battery": 1,
      "last-seen-y-coordinate": 1.1,
      "status": 0,
      "entity-id": "sample string 2"
    },
    {
      "last-seen-time": "2025-05-30T19:11:20.5144672-07:00",
      "last-seen-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "moved-from-location": {
        "name": "sample string 1",
        "entity-id": "sample string 2"
      },
      "disposition": 0,
      "latitude": 1.1,
      "longitude": 1.1,
      "last-seen-provider": 1,
      "last-seen-x-coordinate": 1.1,
      "battery": 1,
      "last-seen-y-coordinate": 1.1,
      "status": 0,
      "entity-id": "sample string 2"
    }
  ]
}

Response Information

Resource Description

TagBatchResponse
NameDescriptionTypeAdditional information
tags

Collection of TagvueBatchResponse

None.

Response Formats

application/xml, text/xml

Sample:
<TagBatchResponse>
  <TagResponses>
    <TagvueBatchResponse entity-id="sample string 3">
      <is-success>true</is-success>
      <error-message>sample string 2</error-message>
      <status-code>OK</status-code>
    </TagvueBatchResponse>
    <TagvueBatchResponse entity-id="sample string 3">
      <is-success>true</is-success>
      <error-message>sample string 2</error-message>
      <status-code>OK</status-code>
    </TagvueBatchResponse>
  </TagResponses>
</TagBatchResponse>

application/json, text/json

Sample:
{
  "tags": [
    {
      "is-success": true,
      "error-message": "sample string 2",
      "status-code": 0,
      "entity-id": "sample string 3"
    },
    {
      "is-success": true,
      "error-message": "sample string 2",
      "status-code": 0,
      "entity-id": "sample string 3"
    }
  ]
}