This documentation is in beta, and might contain errors. Contact us at integration@instabee.com with any questions.

Instabee API

Locker Delivery Events

Locker delivery events are configured by our integration team. Contact the integration team for more information.

The checkpoint types, payload, and parameters below are examples. Additional events can be configured for specific cases, and webhook parameters and payload structure can also be configured.

Checkpoint Types

TypeDescription
InitialCheckpointOrder information received
InitialReturnCheckpointReturn activated, depends on the order type. In some cases InitialCheckpoint will be sent instead
SortingMachineCheckpointSorted
SortingStationCheckpointSorted
CourierDropoffCheckpointDropped off at locker by courier
CourierPickupCheckpointPicked up at locker by courier
CustomerPickupCheckpointPicked up at locker by customer
CustomerDropoffCheckpointDropped off at locker by customer
ReturnedToSenderCheckpointParcel returned to sender
ReturnToSenderCheckpointReturn to sender
ParcelLostCheckpointParcel was lost. Please contact us to find out why.
ChangePickupPointCheckpointConsumer initiated pickup point change. This can affect delivery time.
CustomerHomeDeliveryBookedHome Delivery is booked
CustomerHomeDeliverySuccessHome delivery was successful, parcel is delivered to customer
CustomerHomeDeliveryFailHome delivery failed, parcel was not delivered to customer

Webhook Payload

1{
2  "checkpointId": "cp_abc123",
3  "parcelId": "SHOP000000123456",
4  "orderNumber": "ORD-12345",
5  "type": "CustomerPickupCheckpoint",
6  "typeDescription": "Consumer picked up parcel from locker",
7  "locationName": "Central Station Stockholm",
8  "timestamp": "2025-06-01T16:10:00Z"
9}

Webhook Payload Parameters

paramTypeDescription
checkpointIdstringUnique checkpoint identifier
parcelIdstringYour parcel ID
orderNumberstringYour order number
typestringCheckpoint type (see table above)
typeDescriptionstringHuman-readable description
locationNamestringName of the location where the checkpoint occurred
timestampstringISO 8601 UTC timestamp

Command Palette

Search for a command to run...