Skip to content

Jigcar Public APIs (1.0.0-alpha)

Public APIs for interacting with Jigcar

Download OpenAPI description
openapi-v1.json
openapi-v1.yaml
Overview
URL
https://jigcar.com/
E-mail
engineering@jigcar.com
License
MIT
Languages
Servers
Mock server
https://docs.jigcar.com/_mock/openapi-v1
https://public-api.jigcar.com/v1

Movement Requests

Endpoints for creating/retrieving Jigcar movement requests

Operations

Infrastructure

Endpoints for retrieving Logistics specific infrastructure within Jigcar

Operations

Prep Jobs

Endpoints for managing prep jobs at prep sites

Operations

Mark prep job as appraised

Request

Transitions a prep job to the APPRAISED stage. Lookup by VIN or VRM (VIN takes precedence if both provided). At least one of vin or vrm must be provided.

Security
JigcarAPIAuth
Query
vinstring

Vehicle Identification Number

Example: vin=1C6RR7FT9ES349880
vrmstring

Vehicle Registration Mark

Example: vrm=SX05CWO
curl -i -X PATCH \
  'https://docs.jigcar.com/_mock/openapi-v1/prep-jobs/appraised?vin=1C6RR7FT9ES349880&vrm=SX05CWO' \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE'

Responses

Prep job transitioned to APPRAISED

Bodyapplication/json
idstring(ulid)required

The identifier for the prep job

Example: "01H6SKC5ZDMX0PH7QJJDHJRH7G"
vinstringrequired

The Vehicle Identification Number

Example: "1C6RR7FT9ES349880"
vrmstring

The Vehicle Registration Mark

Example: "SX05CWO"
makestring

The make of the vehicle

Example: "Seat"
modelstring

The model of the vehicle

Example: "Ibiza"
modelVariantstring

The extended description of the vehicle

Example: "FR Sport"
prepSiteIdstringrequired

The identifier for the prep site processing this vehicle

Example: "site-prep-01"
businessAreastring(BusinessArea)required
Enum"Retail""Fleet"
sourcestring(PrepJobSource)required
Enum"CREATED_VMR""CREATED_MANUALLY"
stagestring(PrepJobStage)required
Enum"INBOUND""ARRIVED""APPRAISED""OUTBOUND"
substagestring(OutboundSubstage)
Enum"SCHEDULED""DELIVERED"
notesstring<= 1024 characters

Any notes relating to the prep job

createdByUserstringrequired

Email of the user who created the prep job

Example: "user@example.com"
createdAtstring(datetime)(DateTime)required
updatedAtstring(datetime)(DateTime)required
Response
application/json
{
  "id": "01H6SKC5ZDMX0PH7QJJDHJRH7G",
  "vin": "1C6RR7FT9ES349880",
  "vrm": "SX05CWO",
  "make": "Seat",
  "model": "Ibiza",
  "modelVariant": "FR Sport",
  "prepSiteId": "site-prep-01",
  "businessArea": "Retail",
  "source": "CREATED_MANUALLY",
  "stage": "APPRAISED",
  "substage": "SCHEDULED",
  "notes": "string",
  "createdByUser": "user@example.com",
  "createdAt": "2025-07-01T09:00:00.000Z",
  "updatedAt": "2025-07-01T09:00:00.000Z"
}