Definitions and Types

Entities and identifiers

Entity	Definition	Identity
Account	An Account is by definition a single person that can use the MyPup platform. A single account can login to the platform using a username and password and/or an API key.	UserUid
Dispatcher	A Dispatcher is a special kind of Account that can send, deliver and manage shipments from and to other accounts. Dispatchers can also use the MyPup API.	DispatcherUid
Shipment	Shipments are a single registration of packages or letters.	ShipmentUid
Locker	A Locker is a point of delivery or pick-up within a PickUpPoint. Lockers can be booked by by both Accounts and Dispatchers (if allowed).	LockerUid
PickUpPoint	A PickUpPoint is a collection of Lockers that reside on a single location.	PupUid or PickUpPointUid

Other definitions

Term	Definition
Main PickUpPoint	Each account has a default PickUpPoint that will be used when receiving or sending shipments. Only Dispatchers are allowed to override the main PickUpPoints of normal accounts.
Main Dispatcher Account	Each Dispatcher has a main account. This main account will be used as a source or target account of shipments that will be send to or received by the Dispatcher.

Shipment Types

A shipment is categorized into a couple of types. Each type has a different type of flow.

Type (code)	Description
LocalPupShipment	Peer to peer shipments. Shipments are delivered and picked up at the same PickUpPoint. Both the sender and receiver of the Shipment are known PickUpPoint accounts.
DispatchShipment	Dispatching Shipments from accounts to other physical addresses. These shipments are typically being handled by couriers.
ReceiveShipment	Receiving Shipments from physical addresses to known accounts. These shipments are typically being handled by couriers.
CollectOnlyShipment	Shipments that can be used to book a locker for a single user. This is mostly used to unlock a locker for one time only. But you can also choose to keep the same locker reserved until it is cancelled.

Shipment States

A shipment can transition through multiple states.

State (code)	Description	Next
Initial	Shipments always have an initial state. If the shipment is correctly created then it will transition to the next state.	LockerAssigned, Cancelled
LockerAssigned	Locker is assigned and booked for the shipment.	WaitForDropoff, WaitForPriorReady, Cancelled
WaitForPriorReady	The shipment swaps another shipments. Waiting for the other shipment to be placed in the PickUpPoint and be ReadyForPickup	WaitForDropoff, Cancelled
WaitForDropoff	Waiting for shipment to be placed in the PickUpPoint	Arrived, Cancelled
Arrived	Shipment has been dropped of at the PickUpPoint.	WaitForReceiver, ReadyForPickup, Cancelled
WaitForReceiver	Waiting for the receiver to be specified on the shipment.	ReadyForPickup, Cancelled
ReadyForPickup	Shipment has arrived, receiver has been set, waiting for pickup.	Received, Cancelled
Received	Shipment has been picked up at the PickUpPoint.
Cancelled	Generic cancel state. Shipment has been cancelled manually by the dispatcher. When a shipment is cancelled, all reserved lockers are automaticaly released.