Documents REST API

All document operations use the REST API at /api/v2.

Permission Required

These endpoints require the DocumentObservation and DocumentManagement permissions.

For a guided walkthrough, see the Working with Documents guide.

Endpoints

Single document operations

Method	Endpoint	Description
PUT	/api/v2/organisations/{orgId}/documents/{docId}	Create or update a document
GET	/api/v2/organisations/{orgId}/documents/{docId}	Fetch a document
DELETE	/api/v2/organisations/{orgId}/documents/{docId}	Delete a document

PUT query parameters

Parameter	Description
upsert=true	Create the document if it doesn’t exist, update if it does
enableBaseOrgs=true	Auto-create organisations when Core ID doesn’t match an existing connection

Batch operations

Method	Endpoint	Description
POST	/api/v2/organisations/{orgId}/document-jobs/	Submit a batch of documents
GET	/api/v2/organisations/{orgId}/document-jobs/	List all batch jobs
GET	/api/v2/organisations/{orgId}/document-jobs/{batchId}	Get batch job details
GET	/api/v2/organisations/{orgId}/document-jobs/{batchId}/result	Get batch job results
DELETE	/api/v2/organisations/{orgId}/document-jobs/{batchId}	Cancel a batch job

POST query parameters

Parameter	Description
enableBaseOrgs=true	Auto-create organisations when Core ID doesn’t match an existing connection
selfCoreId={value}	Set the location’s self Core ID for matching the occupant in the batch

Document input schema

Property	Type	Required	Description
id	string	Yes	Unique document identifier
direction	string	Yes	Inbound or Outbound
occupant	OrgRef	*	The location organisation
offsite	OrgRef	*	The remote organisation
carrier	OrgRef	*	The transport company
loads	Load[]	No	Array of load line items
settings	object	No	{ mode, maxUses }
validDates	DateRange	No	{ begin, end } — bookable window
preferredDates	DateRange	No	{ begin, end } — preferred dates
description	string	No	Optional description
attributes	object	No	Key-value metadata
status	{ name }	No	Document status label
type	{ name }	No	Document type label

* At least one of occupant, offsite, or carrier must be provided.

Organisation reference

An organisation can be referenced by Mobiledock ID or by Core ID:

// By Mobiledock ID
{ "id": "990090c9-7506-487b-9872-c4e65557ae75" }

// By Core ID
{ "coreName": "SUPPLIER", "coreId": "0001" }

Load object

Property	Type	Required	Description
name	string	Yes	Load type name
quantity	number	Yes	Number of units
loadTag	string	No	Identifier (e.g. SKU)

Document modes

Mode	Description
Free	Booker can modify loads
Fixed	Booker cannot modify loads
Flexible	Booker can modify quantities but not load types

HTTP status codes

Upsert (PUT)

Code	Description
200	Document updated
201	Document created
400	Invalid payload — see response body

Fetch (GET)

Code	Description
200	Document returned

Delete (DELETE)

Code	Description
200	Document deleted