Core Concepts
Before working with the Mobiledock API, familiarise yourself with the following terms. They appear throughout the guides and API reference.
Booking
Section titled “Booking”A booking represents a scheduled visit to a Mobiledock-controlled site. Each booking has a time, location, carrier, vehicle, and one or more tasks. Bookings progress through a series of statuses (e.g. Pending, Approved, Completed) defined by the location’s configuration.
A task is a single line item within a booking. It describes what is being delivered or collected — including a direction (inbound or outbound), sender, receiver, document reference, and load quantities. A booking can contain multiple tasks.
Document
Section titled “Document”A document is a record of a pre-determined reason to visit a site. Most commonly, documents model a Purchase Order (PO), an Advanced Shipping Notice (ASN), or a Work Order. Documents are submitted via the REST API and referenced when creating bookings.
See the Working with Documents guide for full details.
Occupant
Section titled “Occupant”The occupant is the organisation that occupies the location — typically the warehouse or distribution centre. For inbound deliveries, the occupant is the receiver. For outbound shipments, the occupant is the sender.
Offsite
Section titled “Offsite”The offsite is the remote organisation in a document — typically a supplier or customer. For inbound deliveries, the offsite is the sender. For outbound shipments, the offsite is the receiver.
Carrier
Section titled “Carrier”The carrier is the transport company responsible for the physical movement of goods. A carrier is always associated with a booking.
Core ID
Section titled “Core ID”A Core ID is a unique identifier that maps an organisation in your system to an organisation in Mobiledock. When submitting documents via the REST API, you reference offsites by their coreName and coreId rather than by their Mobiledock UUID. This allows Mobiledock to match your external identifiers to its internal organisations.
A pass validates that an entity (such as a driver or vehicle) is authorised to access a site. Passes belong to a pass type (e.g. “Driver Induction”) and have a validity period, attributes, and an optional URL.
See the Working with Passes guide for full details.
Location
Section titled “Location”A location is a physical site managed by Mobiledock — a warehouse, distribution centre, factory, or similar. Locations have areas, spaces, rules, and configuration that govern how bookings are created and managed.
An area is a subdivision of a location — for example, “West Dock” or “South Docks”. Some locations require you to select an area when creating a booking.
A space is a specific dock bay or slot within an area. Spaces are assigned to bookings to indicate where the vehicle should park.
Organisation
Section titled “Organisation”An organisation is any entity in Mobiledock — a location, carrier, supplier, or tenant. Most API operations require an organisationId to establish context.