Tapahtumapayloadit Ja Seurantatilat

Tämä viitesivu näyttää esimerkkipayloadit kaikille lähteville webhook- tapahtumille, joita Shipit tällä hetkellä tukee.

Huomioita esimerkeistä

Alla olevat payloadit vastaavat tämänhetkistä lähetettävää rakennetta.
Osa arvoista voi olla null lähetyksestä tai tapahtumasta riippuen.
Lompakon credit- ja debit-tapahtumissa ei tällä hetkellä ole ylimmän tason event-kenttää.

`shipment.booked`

{
  "event": "shipment.booked",
  "shipment": {
    "id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
    "shipit_number": "SHP-2024-001234",
    "tracking_number": "1Z999AA10123456784",
    "tracking_number_2": null,
    "service_id": "ups_express",
    "carrier_code": "ups",
    "reference": "ORDER-12345",
    "external_id": "ext-abc-123",
    "price": "15.99",
    "currency": "EUR",
    "created_at": "2024-01-15T10:30:00+00:00"
  },
  "sender": {
    "name": "Acme Corp",
    "email": "[email protected]",
    "phone": "+358401234567",
    "street": "Warehouse Street 10",
    "postcode": "00100",
    "city": "Helsinki",
    "country": "FI"
  },
  "receiver": {
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+358409876543",
    "street": "Customer Road 5",
    "postcode": "00200",
    "city": "Espoo",
    "country": "FI"
  }
}

`shipment.failed`

{
  "event": "shipment.failed",
  "error_message": "Recipient address could not be validated",
  "shipment_data": {
    "serviceId": "dhl_express",
    "reference": "ORDER-12346",
    "externalId": "ext-abc-124",
    "sender": {
      "name": "Acme Corp"
    },
    "receiver": {
      "name": "John Doe"
    }
  }
}

`shipment.tracking_event_updated`

{
  "event": "shipment.tracking_event_updated",
  "shipment": {
    "id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
    "shipit_number": "SHP-2024-001234",
    "tracking_number": "1Z999AA10123456784",
    "tracking_number_2": null,
    "service_id": "ups_express",
    "carrier_code": "ups",
    "reference": "ORDER-12345",
    "external_id": "ext-abc-123"
  },
  "tracking_event": {
    "id": "01hxtrackingevent1234567890",
    "status": "DELIVERED",
    "shipment_tracking_number": "1Z999AA10123456784",
    "parcel_tracking_number": "1Z999AA10123456784",
    "return_tracking_number": null,
    "description": {
      "en": "Shipment delivered"
    },
    "information": null,
    "instruction": null,
    "location": {
      "city": "Helsinki",
      "country": "FI"
    },
    "metadata": {
      "carrier_event_code": "DELIVERED"
    },
    "happened_at": "2024-01-15T10:30:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_at": "2024-01-15T10:35:00+00:00"
  }
}

`pending_shipment.created`

{
  "event": "pending_shipment.created",
  "pending_shipment": {
    "id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
    "external_id": "pending-ext-123",
    "status": "pending",
    "source": "api",
    "request": {
      "receiver": {
        "name": "Jane Smith",
        "email": "[email protected]"
      },
      "parcels": [
        {
          "weight": 2.5,
          "length": 30,
          "width": 20,
          "height": 10
        }
      ]
    },
    "created_at": "2024-01-15T10:00:00+00:00"
  }
}

`pending_shipment.completed`

{
  "event": "pending_shipment.completed",
  "pending_shipment": {
    "id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
    "external_id": "pending-ext-123",
    "status": "completed",
    "source": "api",
    "request": {
      "receiver": {
        "name": "Jane Smith",
        "email": "[email protected]"
      },
      "parcels": [
        {
          "weight": 2.5,
          "length": 30,
          "width": 20,
          "height": 10
        }
      ]
    },
    "created_at": "2024-01-15T10:00:00+00:00",
    "updated_at": "2024-01-15T10:30:00+00:00"
  }
}

`wallet.credited`

{
  "transaction_id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
  "amount": "100.00",
  "vat": "24.00",
  "vat_percent": "24",
  "comment": "Account top-up",
  "created_at": "2024-01-15T10:00:00+00:00",
  "user_id": "12345"
}

`wallet.debited`

{
  "transaction_id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
  "amount": "-15.99",
  "vat": "-3.84",
  "vat_percent": "24",
  "comment": "Payment for shipment SHP-2024-001234",
  "shipment_id": "01h2x4y6z8a9b0c1d2e3f4g5h7",
  "created_at": "2024-01-15T10:30:00+00:00",
  "user_id": "12345"
}

`wallet.low_balance`

{
  "event": "wallet.low_balance",
  "wallet": {
    "user_id": "01h2x4y6z8a9b0c1d2e3f4g5h6",
    "current_balance": 500,
    "threshold": 1000,
    "balance_below_threshold": true,
    "difference": 500
  },
  "timestamp": "2024-01-15T11:00:00+00:00"
}

Seurantatapahtumien tilat

shipment.tracking_event_updated-tapahtuman kenttä tracking_event.status voi olla mikä tahansa seuraavista enum-arvoista:

Tila	Merkitys
`ADVANCED_SHIPPING_NOTICE`	Kuljetusyhtiö on saanut ennakkoilmoituksen ennen fyysistä luovutusta.
`AT_OFFICE_OF_EXCHANGE`	Lähetys saapui vaihto- tai siirtotoimipaikkaan.
`ATTEMPTED_DELIVERY`	Toimitusta yritettiin.
`AWAITING_DELIVERY`	Lähetys odottaa lopullista toimitusta.
`AWAITING_DELIVERY_TIME_SELECTION`	Vastaanottajan pitää valita toimitusaika.
`AWAITING_DISPATCH`	Lähetys odottaa lähtöä tai kuljetukseen siirtoa.
`CANCELLED`	Lähetys tai kuljetusvaihe peruttiin.
`CASH_ON_DELIVERY`	Lähetykseen liittyy postiennakko.
`COLLECTED`	Lähetys on noudettu.
`CONFIRMED`	Kuljetusyhtiö vahvisti lähetyksen tai tapahtuman.
`CONSOLIDATED`	Lähetys yhdistettiin muuhun rahtiin.
`DAMAGED`	Kuljetusyhtiö raportoi vaurion.
`DECONSOLIDATED`	Lähetys erotettiin yhdistetystä kulusta.
`DELAYED`	Lähetys on viivästynyt.
`DELETED`	Lähetys tai tapahtuma poistettiin lähdejärjestelmässä.
`DELIVERED`	Lähetys toimitettiin.
`DELIVERY_CANCELLED`	Suunniteltu toimitus peruttiin.
`DELIVERY_IMPOSSIBLE`	Toimitusta ei voitu suorittaa.
`DELIVERY_REFUSED`	Vastaanottaja kieltäytyi toimituksesta.
`DELIVERY_TIME_SELECTED`	Vastaanottaja valitsi toimitusajan.
`DISPATCHED`	Lähetys on lähtenyt kuljetukseen.
`EN_ROUTE`	Lähetys liikkuu kuljetusverkossa.
`EXCEPTION`	Kuljetusyhtiö raportoi poikkeaman.
`EXTRA_SERVICE`	Tapahtumaan liittyy lisäpalvelutieto.
`IN_CUSTOMS`	Lähetys on tullikäsittelyssä.
`LOST`	Kuljetusyhtiö raportoi lähetyksen kadonneeksi.
`NOTICE_OF_ARRIVAL`	Saapumisilmoitus on lähetetty tai luotu.
`OTHER`	Tapahtuma ei sopinut tarkempaan tilaan.
`OUT_FOR_DELIVERY`	Lähetys on jakelussa.
`PARTIALLY_DELIVERED`	Vain osa lähetyksestä toimitettiin.
`PICK_UP_CANCELLED`	Nouto peruttiin.
`RECIPIENT_CONTACTED`	Vastaanottajaan on otettu yhteyttä.
`REGISTERED`	Lähetys rekisteröitiin kuljetusyhtiön järjestelmään.
`REROUTING`	Lähetystä ohjataan uudelle reitille.
`RETURNED`	Lähetys palautettiin.
`RETURNING`	Lähetys on palaamassa lähettäjälle.
`SORTING`	Lähetys on lajittelussa.
`TEST`	Testitila lähdejärjestelmältä.
`UNCONFIRMED`	Tapahtumaa ei ole vielä vahvistettu.
`UNKNOWN`	Tila on tuntematon.
`UNSUCCESSFUL_DELIVERY`	Toimitus epäonnistui.
`UNSUCCESSFUL_DELIVERY_ATTEMPT`	Toimitusyritys epäonnistui.
`UNSUCCESSFUL_DISPATCH`	Lähetys ei lähtenyt onnistuneesti.
`UNSUCCESSFUL_DISPATCH_ATTEMPT`	Lähetyksen lähtöyritys epäonnistui.