Sündmuste Payloadid Ja Jälgimisolekud

See viiteleht näitab näidispayloade kõigi väljaminevate webhook- sündmuste jaoks, mida Shipit praegu toetab.

Märkused näidete kohta

  • Allolevad payloadid vastavad praegusele tegelikule väljundkujule.
  • Mõned väärtused võivad sõltuvalt saadetisest või sündmusest olla null.
  • Rahakoti credit- ja debit-sündmustel puudub praegu ülemise taseme event väli.

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"
}

Jälgimissündmuste olekud

tracking_event.status väljal sündmuses shipment.tracking_event_updated võib olla üks järgmistest enum-väärtustest:

OlekTähendus
ADVANCED_SHIPPING_NOTICEVedaja sai eelteavituse enne füüsilist üleandmist.
AT_OFFICE_OF_EXCHANGESaadetis jõudis vahetus- või ülekandepunkti.
ATTEMPTED_DELIVERYKohaletoimetamist prooviti.
AWAITING_DELIVERYSaadetis ootab lõplikku kohaletoimetamist.
AWAITING_DELIVERY_TIME_SELECTIONSaaja peab valima kohaletoimetamise aja.
AWAITING_DISPATCHSaadetis ootab teele saatmist.
CANCELLEDSaadetis või transpordietapp tühistati.
CASH_ON_DELIVERYSaadetisega on seotud lunamakse.
COLLECTEDSaadetis on peale võetud.
CONFIRMEDVedaja kinnitas saadetise või sündmuse.
CONSOLIDATEDSaadetis koondati muu kaubaga.
DAMAGEDVedaja teatas kahjustusest.
DECONSOLIDATEDSaadetis eraldati koondatud voost.
DELAYEDSaadetis hilineb.
DELETEDSaadetis või sündmus eemaldati lähteallikast.
DELIVEREDSaadetis on kohale toimetatud.
DELIVERY_CANCELLEDPlaneeritud kohaletoimetamine tühistati.
DELIVERY_IMPOSSIBLEKohaletoimetamist ei olnud võimalik lõpetada.
DELIVERY_REFUSEDSaaja keeldus saadetist vastu võtmast.
DELIVERY_TIME_SELECTEDSaaja valis kohaletoimetamise aja.
DISPATCHEDSaadetis saadeti teele.
EN_ROUTESaadetis liigub võrgus edasi.
EXCEPTIONVedaja teatas erandist või kõrvalekaldest.
EXTRA_SERVICESündmusele lisati lisateenuse info.
IN_CUSTOMSSaadetis on tollis.
LOSTVedaja märkis saadetise kadunuks.
NOTICE_OF_ARRIVALSaabumisteade saadeti või loodi.
OTHERSündmust ei saanud siduda täpsema olekuga.
OUT_FOR_DELIVERYSaadetis on kulleriga väljas.
PARTIALLY_DELIVEREDKohale toimetati ainult osa saadetisest.
PICK_UP_CANCELLEDPealekorje tühistati.
RECIPIENT_CONTACTEDVedaja võttis saajaga ühendust.
REGISTEREDSaadetis registreeriti vedaja süsteemis.
REROUTINGSaadetist suunatakse ümber.
RETURNEDSaadetis tagastati.
RETURNINGSaadetis on teel tagasi saatjale.
SORTINGSaadetis on sorteerimises.
TESTTestolek upstream-allikast.
UNCONFIRMEDSündmus on olemas, kuid kinnitamata.
UNKNOWNOlek on tundmatu.
UNSUCCESSFUL_DELIVERYKohaletoimetamine ebaõnnestus.
UNSUCCESSFUL_DELIVERY_ATTEMPTKohaletoimetamise katse ebaõnnestus.
UNSUCCESSFUL_DISPATCHTeele saatmine ebaõnnestus.
UNSUCCESSFUL_DISPATCH_ATTEMPTTeele saatmise katse ebaõnnestus.
Last Updated:
Contributors: Brian Faust