Skip to main content
GET
/
events
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2023-11-07T05:31:56Z",
    "eventTime": "2023-11-07T05:31:56Z",
    "eventType": "ASSOCIATION_EVENT",
    "action": "OBSERVE",
    "eventTag": "<string>",
    "bizStep": "ACCEPTING",
    "disposition": "ACTIVE",
    "quantityList": [
      {
        "epcClass": "<string>",
        "quantity": 123,
        "unit": "<string>"
      }
    ],
    "outputQuantityList": [
      {
        "epcClass": "<string>",
        "quantity": 123,
        "unit": "<string>"
      }
    ],
    "inputQuantityList": [
      {
        "epcClass": "<string>",
        "quantity": 123,
        "unit": "<string>"
      }
    ],
    "sourceList": [
      {
        "sourceType": "OWNING_PARTY",
        "source": "<string>"
      }
    ],
    "destinationList": [
      {
        "destinationType": "OWNING_PARTY",
        "destination": "<string>"
      }
    ],
    "readPoint": {
      "identifier": "<string>",
      "location": "<string>",
      "lat": 123,
      "lng": 123
    }
  }
]

Query Parameters

page
number
default:1

Page number (1-based)

limit
number
default:10

Number of items per page

Response

200 - application/json

The events have been successfully retrieved

id
string<uuid>
required

The id of the event

Example:

"123e4567-e89b-12d3-a456-426614174000"

createdAt
string<date-time>
required

The time of the event was created

eventTime
string<date-time>
required

The time of the event

eventType
enum<string>
required

The type of the event

Available options:
ASSOCIATION_EVENT,
OBJECT_EVENT,
AGGREGATION_EVENT,
TRANSACTION_EVENT,
TRANSFORMATION_EVENT
action
enum<string>
required

The action of the event

Available options:
OBSERVE,
ADD,
DELETE
eventTag
string

The tag associated with the event

bizStep
enum<string>

The business step associated with the event

Available options:
ACCEPTING,
ARRIVING,
ASSEMBLING,
COLLECTING,
COMMISSIONING,
CONSIGNING,
CREATING_CLASS_INSTANCE,
CYCLE_COUNTING,
DECOMMISSIONING,
DEPARTING,
DESTROYING,
DISASSEMBLING,
DISPENSING,
ENCODING,
ENTERING_EXITING,
HOLDING,
INSPECTING,
INSTALLING,
KILLING,
LOADING,
OTHER,
PACKING,
PICKING,
RECEIVING,
REMOVING,
REPACKAGING,
REPAIRING,
REPLACING,
RESERVING,
RETAIL_SELLING,
SHIPPING,
STAGING_OUTBOUND,
STOCK_TAKING,
STOCKING,
STORING,
TRANSPORTING,
UNLOADING,
UNPACKING,
VOID_SHIPPING,
SENSOR_REPORTING,
SAMPLING
disposition
enum<string>

The disposition of the event

Available options:
ACTIVE,
CONTAINER_CLOSED,
DAMAGED,
DESTROYED,
DISPENSED,
DISPOSED,
ENCODED,
EXPIRED,
IN_PROGRESS,
IN_TRANSIT,
INACTIVE,
NO_PEDIGREE_MATCH,
NON_SELLABLE_OTHER,
PARTIALLY_DISPENSED,
RECALLED,
RESERVED,
RETAIL_SOLD,
RETURNED,
SELLABLE_ACCESSIBLE,
SELLABLE_NOT_ACCESSIBLE,
STOLEN,
UNKNOWN,
AVAILABLE,
COMPLETENESS_VERIFIED,
COMPLETENESS_INFERRED,
CONFORMANT,
CONTAINER_OPEN,
MISMATCH_INSTANCE,
MISMATCH_CLASS,
MISMATCH_QUANTITY,
NEEDS_REPLACEMENT,
NON_CONFORMANT,
UNAVAILABLE
quantityList
object[]

List of quantities associated with the event

outputQuantityList
object[]

Output list of quantities associated with the event

inputQuantityList
object[]

Input list of quantities associated with the event

sourceList
object[]

List of sources associated with the event

destinationList
object[]

List of destinations associated with the event

readPoint
object

The read point associated with the event