Event

Example payload

{
  "object": "event",
  "id": 775,
  "event_type_code": "label_created",
  "happened_at": "2024-07-17T00:00:00Z",
  "message": null,
  "raw": null,
  "messages": {
    "en": "Label Created, tracking details will be available once the package arrives at the LaserShip facility",
    "fr": "Etiquette colis crée, les informations de suivi seront disponible lorsque le colis arrivera au centre Lasership"
  },
  "standard_event": {
    "name": "",
    "slug": "in_transit"
  },
  "address": null
}

Attributes

FIELD	DESCRIPTION
event_type_code string	See Event type codes
happened_at datetime	Datetime at which the event occurred. Can be null if the carrier has not shared with us a value.
message string	Event message. Shipup cannot guarantee that this message will stay unchanged for the same event type. Shipping carriers or Shipup might edit them at any time so don't use them as a lookup key
raw string (JSON or HTML)	Raw information of the carrier. Depending on the carrier, format can be HTML or JSON, both expressed as a string
messages object	Object whose keys are language codes. Corresponds to the messages for this event depending on the language (for instance, of the tracking page)
standard_event object	This object will only appear when the carrier event is associated with a standard event (predefines the notification that will be sent to the client, as well as the text exhibited in the tracking page).
slug string	Internal key for the type of event it represents (more specific than event_type_code), see Event type codes
name string	A readable name for the standard event associated with the event.
address object, optional	Address at which the event took place if known, see Address