Shipment payload

Shipment notification name

Event
Path
Method

shipment_created

/shipment

POST

shipment_updated

/shipment/{shipmentId}

PUT

shipment_deleted

/shipment/{shipmentId}

DELETE

Shipment create payload

{
  "event": "shipment_created",
  "resource": {
    "id": "00000000-0000-0000-0000-000000000000",
    "data": {
      "shipmentId": "00000000-0000-0000-0000-000000000000",
      "orderReference": "REF-000000"
    }
  },
  "actor": {
    "type": "user",
    "id": "00000000-0000-0000-0000-000000000000",
    "societyId": "384221164-00062",
    "societyName": "Technema"
  },
  "params": {
    "orderReference": "REF-000000"
  }
}

Shipment update payload

{
  "event": "shipment_updated",
  "resource": {
    "id": "00000000-0000-0000-0000-000000000000",
    "data": {
      "shipmentId": "00000000-0000-0000-0000-000000000000",
      "orderReference": "REF-000001"
    }
  },
  "actor": {
    "type": "user",
    "id": "00000000-0000-0000-0000-000000000000",
    "societyId": "384221164-00062",
    "societyName": "Technema"
  },
  "params": {
    "orderReference": "REF-000001"
  }
}

Shipment delete payload

{
  "event": "shipment_deleted",
  "resource": {
    "id": "00000000-0000-0000-0000-000000000000",
    "data": {
      "shipmentId": "00000000-0000-0000-0000-000000000000",
      "orderReference": "REF-000000"
    }
  },
  "actor": {
    "type": "user",
    "id": "00000000-0000-0000-0000-000000000000",
    "societyId": "384221164-00062",
    "societyName": "Technema"
  },
  "params": {}
}

Last updated