Shipment event payload

Shipment event notification name

Event
Path
Method

shipment_event_created

/shipment_event

POST

shipment_event_updated

/shipment_event/{shipmentId}

PUT

shipment_event_deleted

/shipment_event/{shipmentId}

DELETE

Shipment event create payload

{
  "event": "shipment_event_created",
  "resource": {
    "id": "00000000-0000-0000-0000-000000000000",
    "data": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "ORDER",
      "eta": "yyyy-MM-dd HH:mm:ss",
      "ata": "yyyy-MM-dd HH:mm:ss",
      "comment": "comment"
    },
    "operators": {
      "societyId": "123456789-00001"
    },
    "actor": {
      "type": "user",
      "id": "00000000-0000-0000-0000-000000000000",
      "societyId": "384221164-00062",
      "societyName": "Technema"
    },
    "params": {
      "type": "ORDER",
      "eta": "yyyy-MM-dd HH:mm:ss",
      "ata": "yyyy-MM-dd HH:mm:ss",
      "comment": "comment"
    }
  }
}

Shipment event update payload

{
  "event": "shipment_event_updated",
  "resource": {
    "id": "00000000-0000-0000-0000-000000000000",
    "data": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "MEASUREMENT"
    },
    "operators": {
      "societyId": "123456789-00001"
    },
    "actor": {
      "type": "user",
      "id": "00000000-0000-0000-0000-000000000000",
      "societyId": "384221164-00062",
      "societyName": "Technema"
    },
    "params": {
      "type": "MEASUREMENT"
    }
  }
}

Shipment event delete payload

{
  "event": "shipment_event_deleted",
  "resource": {
    "id": "00000000-0000-0000-0000-000000000000",
    "data": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "ORDER",
      "eta": "yyyy-MM-dd HH:mm:ss",
      "ata": "yyyy-MM-dd HH:mm:ss",
      "comment": "comment"
    },
    "operators": {
      "societyId": "123456789-00001"
    },
    "actor": {
      "type": "user",
      "id": "00000000-0000-0000-0000-000000000000",
      "societyId": "384221164-00062",
      "societyName": "Technema"
    }
  }
}

Last updated