This endpoint allows you to look up items and their attributes based on their EPC.

Through this endpoint, you can only lookup EPCs bearing Tag Issuer IDs (or Tag Issuer Codes) associated with your organization’s accounts. This value can be found by looking at characters 5 through 8 of the EPC (in hex notation). See The Kit Check EPC for more details.

Request

Method

POST {data-service}/v2/tags/summarize

Header

Api-Key: 0123456789ABCDEF
Content-Type: application/json

Body

Body Fields

Body Example

{
    "epcs": [
        "800100000000000000000000",
        "800100000000000000000001",
        "800100000000000000000002"
    ]
}

Response

HTTP status codes

• 200 OK
• 422 Unprocessable Entity

Header

In addition to content-type, the response header will also contain a request ID that can be useful for troubleshooting.

Content-Type: application/json

X-Request-Id: e23301a0-b214-4a9d-a060-becb8dbc8c93

Body

Body Fields

Body

Example Body — 200 Success

In the event that all tags/EPCs have been associated with drug or item data.

{
  "data": {
    "800100000000000000000000": {
      "ndc_upc_hri_full": "0000-0000-00",
      "lot_number": "20150812AA",
      "expiration": "2019-10-17",
      "restricted": false
    },
    "800100000000000000000001": {
      "ndc_upc_hri_full": "0000-0000-00",
      "lot_number": "20150812AA",
      "expiration": "2019-10-17",
      "restricted": true
    },
    "800100000000000000000002": {
      "ndc_upc_hri_full": "0000-0000-00",
      "lot_number": "20150812AA",
      "expiration": "2019-10-17",
      "restricted": true
    }
  }
}

Example Body — 200 Success

In the event that a tag/EPC is valid, but hasn’t yet been associated with any drug or item data yet, the ndc_upc_hri_full attribute (and many other attributes) will be null.

{
  "data": {
    "800136930000000DEADBEEF0": {
      "ndc_upc_hri_full": null,
      "lot_number": null,
      "expiration": null,
      "restricted": null
    }
  }
}

Example Body — 200 Success

In the event that a tag/EPC is invalid, the tag/EPC will be returned in a list of missing_epcs.

{
  "data": {
  },
  "errors": {
    "missing_epcs": [
      "8001369300003NONEXISTENT"
    ]
  }
}

Example Body – 4xx and 5xx Errors

In the even of a non-200 response status, additional information about the error can be found in the response body.

Make sure to log the error IDs so that Kit Check can help you troubleshoot more efficiently.

{
  "errors" : [
    {
      "status": 422,
      "detail": "A human-readable description of the error",
      "id": "32f63f5f-0936-4446-864f-8742763a80c5"
    }
  ]
}