Skip to content

Create an inbound-pending prep job

Request

Creates a prep job for a vehicle that has been purchased (for example at auction) but has no destination prep site chosen yet. The job is created in stage INBOUND with substage PENDING_MOVEMENT_REQUEST and is parked until a prep site is assigned in Jigcar, at which point an inbound movement is created and the job moves onto that site's board.

At least one of vehicle.vin / vehicle.vrm must be provided; when only a VRM is given a VIN placeholder is derived from it. purchaseDate is a calendar date interpreted in the caller's timezone. businessArea must be one of the defaults (Retail, Fleet) or a custom business area configured for the organisation.

Posting a vehicle that already has an active prep job returns 409 Conflict without creating anything, so repeating the call for the same purchase is a safe no-op.

Security
JigcarAPIAuth
Bodyapplication/jsonrequired
vehicleobjectrequired

Details of the purchased vehicle. At least one of vin or vrm must be provided.

originInternalLocation (object) or ExternalLocation (object)required
One of:

Where the vehicle is coming from (e.g. the auction site it was purchased at)

purchaseDatestring, (date)(Date)

The date the vehicle was purchased, interpreted in the caller's timezone

Example:"2023-10-29"
businessAreastring, <= 32 charactersrequired

One of the default business areas (Retail, Fleet) or a custom business area configured for the organisation

Example:"Retail"
notesstring, <= 1024 characters

Any notes relating to the prep job

curl -i -X POST \
  https://docs.jigcar.com/_mock/openapi-v1/prep-jobs/inbound-pending \
  -H 'Content-Type: application/json' \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "vehicle": {
      "vin": "1C6RR7FT9ES349880",
      "vrm": "SX05CWO",
      "make": "Seat",
      "model": "Ibiza",
      "modelVariant": "FR Sport",
      "colour": "Blue"
    },
    "origin": {
      "type": "INTERNAL",
      "siteId": "some-site-id"
    },
    "purchaseDate": "2023-10-29",
    "businessArea": "Retail",
    "notes": "string"
  }'

Responses

Inbound-pending prep job created

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"
Example:"Retail"
sourcestring(PrepJobSource)required
Enum:"CREATED_VMR""CREATED_MANUALLY""CREATED_API"
Example:"CREATED_MANUALLY"
stagestring(PrepJobStage)required
Enum:"INBOUND""ARRIVED""APPRAISED""OUTBOUND"
Example:"APPRAISED"
substagestring(Substage)

Substage within the current stage. INBOUND jobs support PENDING_MOVEMENT_REQUEST (vehicle purchased, destination prep site not chosen yet). OUTBOUND jobs support PENDING_MOVEMENT_REQUEST, SCHEDULED and DELIVERED.

Enum:"PENDING_MOVEMENT_REQUEST""SCHEDULED""DELIVERED"
Example:"SCHEDULED"
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
Example:"2025-07-01T09:00:00.000Z"
updatedAtstring, (datetime)(DateTime)required
Example:"2025-07-01T09:00:00.000Z"
Response
{
  "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"
}