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

Create vehicle movement request

Request

Creates a movement request for the provided vehicle and sends it to an internal planning pool

Security
JigcarAPIAuth
Bodyapplication/jsonrequired
vehicleobject(Vehicle)required
vehicle.​vinstring

The chassis number of the vehicle

vehicle.​vrmstring

The car reg of the vehicle

vehicle.​makestring

The make of the vehicle

Example: "Mercedes-Benz"
vehicle.​modelstring

The model of the vehicle

Example: "A-Class"
vehicle.​modelVariantstring

the extended description of the vehicle

Example: "A 180 AMG Line Executive Hatchback"
originobject(OriginForCreate)required

The origin of the movement request

origin.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be collected from

One of:

The location the vehicle should be collected from

origin.​location.​typestringrequired
Value"INTERNAL"
origin.​location.​siteIdstringrequired
Example: "some-site-id"
origin.​readyToCollectFromTimeslotstring(Timeslot)required

The time of day the vehicle should be collected on

Enum"ANYTIME""AM""PM"
origin.​readyToCollectFromDatestring(date)(Date)required

The date the vehicle can be collected from

destinationobject(DestinationForCreate)required

The destination of the movement request

destination.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be delivered to

One of:

The location the vehicle should be delivered to

destination.​location.​typestringrequired
Value"INTERNAL"
destination.​location.​siteIdstringrequired
Example: "some-site-id"
destination.​deliveryByTimeslotstring(Timeslot)required

The time of day the vehicle should be delivered on

Enum"ANYTIME""AM""PM"
destination.​deliveryByDatestring(date)(Date)required

The date the vehicle should be delivered by

destination.​deliverOnSpecifiedDateboolean

Whether the vehicle should be delivered on the specified date. Defaults to false.

businessAreastring(BusinessArea)required
Enum"Retail""Fleet"
notesstring

Any important notes relating to the movement request

Example: "Talk to Kevin for keys"
externalIdstring

Any external identifier you want to link with this movement request

Example: "some-external-identifier"
moDelInformationobject

Key information for linking a Jigcar movement request to a MoDel job

transportMethodstring(TransportMethod)required
Enum"DRIVEN""TRANSPORTED"
curl -i -X POST \
  https://docs.jigcar.com/_mock/openapi-v1/movement-requests/create-in-planning-pool \
  -H 'Content-Type: application/json' \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "vehicle": {
      "vin": "string",
      "vrm": "string",
      "make": "Mercedes-Benz",
      "model": "A-Class",
      "modelVariant": "A 180 AMG Line Executive Hatchback"
    },
    "origin": {
      "location": {
        "type": "INTERNAL",
        "siteId": "some-site-id"
      },
      "readyToCollectFromTimeslot": "AM",
      "readyToCollectFromDate": "2023-10-29"
    },
    "destination": {
      "location": {
        "type": "INTERNAL",
        "siteId": "some-site-id"
      },
      "deliveryByTimeslot": "AM",
      "deliveryByDate": "2023-10-29",
      "deliverOnSpecifiedDate": true
    },
    "businessArea": "Retail",
    "notes": "Talk to Kevin for keys",
    "externalId": "some-external-identifier",
    "moDelInformation": {
      "pin": "some-model-pin"
    },
    "transportMethod": "DRIVEN"
  }'

Responses

Created.

Bodyapplication/json
idstring(ulid)required

The identifier for the vehicle movement request

Example: "01K4NNVBR6J323BY6X26J62WA5"
vehicleobject(Vehicle)required
vehicle.​vinstring

The chassis number of the vehicle

vehicle.​vrmstring

The car reg of the vehicle

vehicle.​makestring

The make of the vehicle

Example: "Mercedes-Benz"
vehicle.​modelstring

The model of the vehicle

Example: "A-Class"
vehicle.​modelVariantstring

the extended description of the vehicle

Example: "A 180 AMG Line Executive Hatchback"
originobjectrequired

The origin of the movement request

origin.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be collected from

One of:

The location the vehicle should be collected from

origin.​location.​typestringrequired
Value"INTERNAL"
origin.​location.​siteIdstringrequired
Example: "some-site-id"
origin.​readyToCollectFromTimeslotstring(Timeslot)required

The time of day the vehicle should be collected on

Enum"ANYTIME""AM""PM"
origin.​readyToCollectFromDatestring(date)(Date)required

The date the vehicle can be collected from

origin.​estimatedCollectionTimeslotstring(Timeslot)

The estimated collection timeslot for the vehicle

Enum"ANYTIME""AM""PM"
origin.​estimatedCollectionDatestring(date)(Date)

The estimated collection date for the vehicle

destinationobjectrequired

The destination of the movement request

destination.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be delivered to

One of:

The location the vehicle should be delivered to

destination.​location.​typestringrequired
Value"INTERNAL"
destination.​location.​siteIdstringrequired
Example: "some-site-id"
destination.​deliveryByTimeslotstring(Timeslot)required

The time of day the vehicle should be delivered on

Enum"ANYTIME""AM""PM"
destination.​deliveryByDatestring(date)(Date)required

The date the vehicle should be delivered by

destination.​deliverOnSpecifiedDateboolean

Whether the vehicle should be delivered on the specified date. Defaults to false.

destination.​estimatedDeliveryTimeslotstring(Timeslot)

The estimated delivery timeslot for the vehicle

Enum"ANYTIME""AM""PM"
destination.​estimatedDeliveryDatestring(date)(Date)

The estimated delivery date for the vehicle

statusstring(VehicleMovementRequestStatus)required

The status of the movement request

Enum"CREATED""SENT_TO_DRIVER""SENT_TO_3PL""SENT_TO_MARKETPLACE""SENT_TO_MULTIPLE_DRIVERS""ACCEPTED""ACCEPTED_SENT_TO_DRIVER""ACCEPTED_SENT_TO_3PL""ACCEPTED_SENT_TO_MARKETPLACE""PARTIALLY_PLANNED"
completedOnstring(datetime)(DateTime)

The date that the movement request was completed, if applicable

businessAreastring(BusinessArea)required
Enum"Retail""Fleet"
notesstring

Any important notes relating to the movement request

Example: "Talk to Kevin for keys"
externalIdstring

Any external identifier you want to link with this movement request

Example: "some-external-identifier"
moDelInformationobject

Key information for linking a Jigcar movement request to a MoDel job

transportMethodstring(TransportMethod)required
Enum"DRIVEN""TRANSPORTED"
providerDriverProvider (object) or ThirdPartyLogisticsProvider (object) or MarketplaceProvider (object)
One of:
Response
application/json
{
  "id": "01K4NNVBR6J323BY6X26J62WA5",
  "vehicle": {
    "vin": "string",
    "vrm": "string",
    "make": "Mercedes-Benz",
    "model": "A-Class",
    "modelVariant": "A 180 AMG Line Executive Hatchback"
  },
  "origin": {
    "location": { … },
    "readyToCollectFromTimeslot": "AM",
    "readyToCollectFromDate": "2023-10-29",
    "estimatedCollectionTimeslot": "AM",
    "estimatedCollectionDate": "2023-10-29"
  },
  "destination": {
    "location": { … },
    "deliveryByTimeslot": "AM",
    "deliveryByDate": "2023-10-29",
    "deliverOnSpecifiedDate": true,
    "estimatedDeliveryTimeslot": "AM",
    "estimatedDeliveryDate": "2023-10-29"
  },
  "status": "IN_PROGRESS",
  "completedOn": "2025-07-01T09:00:00.000Z",
  "businessArea": "Retail",
  "notes": "Talk to Kevin for keys",
  "externalId": "some-external-identifier",
  "moDelInformation": {
    "pin": "some-model-pin"
  },
  "transportMethod": "DRIVEN",
  "provider": {
    "type": "DRIVER",
    "id": "some-driver-id",
    "firstname": "John",
    "surname": "Wick"
  }
}

Get vehicle movement request

Request

Retrieves the current state of a vehicle movement request by id

Security
JigcarAPIAuth
Path
requestIdstring(ulid)required

Identifier for a movement request

Example: 01K4NNVBR6J323BY6X26J62WA5
curl -i -X GET \
  https://docs.jigcar.com/_mock/openapi-v1/movement-requests/01K4NNVBR6J323BY6X26J62WA5 \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE'

Responses

Vehicle movement request retrieved

Bodyapplication/json
idstring(ulid)required

The identifier for the vehicle movement request

Example: "01K4NNVBR6J323BY6X26J62WA5"
vehicleobject(Vehicle)required
vehicle.​vinstring

The chassis number of the vehicle

vehicle.​vrmstring

The car reg of the vehicle

vehicle.​makestring

The make of the vehicle

Example: "Mercedes-Benz"
vehicle.​modelstring

The model of the vehicle

Example: "A-Class"
vehicle.​modelVariantstring

the extended description of the vehicle

Example: "A 180 AMG Line Executive Hatchback"
originobjectrequired

The origin of the movement request

origin.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be collected from

One of:

The location the vehicle should be collected from

origin.​location.​typestringrequired
Value"INTERNAL"
origin.​location.​siteIdstringrequired
Example: "some-site-id"
origin.​readyToCollectFromTimeslotstring(Timeslot)required

The time of day the vehicle should be collected on

Enum"ANYTIME""AM""PM"
origin.​readyToCollectFromDatestring(date)(Date)required

The date the vehicle can be collected from

origin.​estimatedCollectionTimeslotstring(Timeslot)

The estimated collection timeslot for the vehicle

Enum"ANYTIME""AM""PM"
origin.​estimatedCollectionDatestring(date)(Date)

The estimated collection date for the vehicle

destinationobjectrequired

The destination of the movement request

destination.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be delivered to

One of:

The location the vehicle should be delivered to

destination.​location.​typestringrequired
Value"INTERNAL"
destination.​location.​siteIdstringrequired
Example: "some-site-id"
destination.​deliveryByTimeslotstring(Timeslot)required

The time of day the vehicle should be delivered on

Enum"ANYTIME""AM""PM"
destination.​deliveryByDatestring(date)(Date)required

The date the vehicle should be delivered by

destination.​deliverOnSpecifiedDateboolean

Whether the vehicle should be delivered on the specified date. Defaults to false.

destination.​estimatedDeliveryTimeslotstring(Timeslot)

The estimated delivery timeslot for the vehicle

Enum"ANYTIME""AM""PM"
destination.​estimatedDeliveryDatestring(date)(Date)

The estimated delivery date for the vehicle

statusstring(VehicleMovementRequestStatus)required

The status of the movement request

Enum"CREATED""SENT_TO_DRIVER""SENT_TO_3PL""SENT_TO_MARKETPLACE""SENT_TO_MULTIPLE_DRIVERS""ACCEPTED""ACCEPTED_SENT_TO_DRIVER""ACCEPTED_SENT_TO_3PL""ACCEPTED_SENT_TO_MARKETPLACE""PARTIALLY_PLANNED"
completedOnstring(datetime)(DateTime)

The date that the movement request was completed, if applicable

businessAreastring(BusinessArea)required
Enum"Retail""Fleet"
notesstring

Any important notes relating to the movement request

Example: "Talk to Kevin for keys"
externalIdstring

Any external identifier you want to link with this movement request

Example: "some-external-identifier"
moDelInformationobject

Key information for linking a Jigcar movement request to a MoDel job

transportMethodstring(TransportMethod)required
Enum"DRIVEN""TRANSPORTED"
providerDriverProvider (object) or ThirdPartyLogisticsProvider (object) or MarketplaceProvider (object)
One of:
Response
application/json
{
  "id": "01K4NNVBR6J323BY6X26J62WA5",
  "vehicle": {
    "vin": "string",
    "vrm": "string",
    "make": "Mercedes-Benz",
    "model": "A-Class",
    "modelVariant": "A 180 AMG Line Executive Hatchback"
  },
  "origin": {
    "location": { … },
    "readyToCollectFromTimeslot": "AM",
    "readyToCollectFromDate": "2023-10-29",
    "estimatedCollectionTimeslot": "AM",
    "estimatedCollectionDate": "2023-10-29"
  },
  "destination": {
    "location": { … },
    "deliveryByTimeslot": "AM",
    "deliveryByDate": "2023-10-29",
    "deliverOnSpecifiedDate": true,
    "estimatedDeliveryTimeslot": "AM",
    "estimatedDeliveryDate": "2023-10-29"
  },
  "status": "IN_PROGRESS",
  "completedOn": "2025-07-01T09:00:00.000Z",
  "businessArea": "Retail",
  "notes": "Talk to Kevin for keys",
  "externalId": "some-external-identifier",
  "moDelInformation": {
    "pin": "some-model-pin"
  },
  "transportMethod": "DRIVEN",
  "provider": {
    "type": "DRIVER",
    "id": "some-driver-id",
    "firstname": "John",
    "surname": "Wick"
  }
}

Update vehicle movement request

Request

Updates specific details of a vehicle movement request by id. Omitting a property will leave it unchanged.

Security
JigcarAPIAuth
Path
requestIdstring(ulid)required

Identifier for a movement request

Example: 01K4NNVBR6J323BY6X26J62WA5
Bodyapplication/jsonrequired
originobject(OriginForUpdate)

The origin of the movement request

destinationobject(DestinationForUpdate)

The destination of the movement request

notesstring

Any important notes relating to the movement request

Example: "I left snacks in the glove compartment"
curl -i -X PATCH \
  https://docs.jigcar.com/_mock/openapi-v1/movement-requests/01K4NNVBR6J323BY6X26J62WA5 \
  -H 'Content-Type: application/json' \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "origin": {
      "location": {
        "type": "INTERNAL",
        "siteId": "some-site-id"
      },
      "readyToCollectFromTimeslot": "AM",
      "readyToCollectFromDate": "2023-10-29"
    },
    "destination": {
      "location": {
        "type": "INTERNAL",
        "siteId": "some-site-id"
      },
      "deliveryByTimeslot": "AM",
      "deliveryByDate": "2023-10-29",
      "deliverOnSpecifiedDate": true
    },
    "notes": "I left snacks in the glove compartment"
  }'

Responses

Vehicle movement request updated

Bodyapplication/json
idstring(ulid)required

The identifier for the vehicle movement request

Example: "01K4NNVBR6J323BY6X26J62WA5"
vehicleobject(Vehicle)required
vehicle.​vinstring

The chassis number of the vehicle

vehicle.​vrmstring

The car reg of the vehicle

vehicle.​makestring

The make of the vehicle

Example: "Mercedes-Benz"
vehicle.​modelstring

The model of the vehicle

Example: "A-Class"
vehicle.​modelVariantstring

the extended description of the vehicle

Example: "A 180 AMG Line Executive Hatchback"
originobjectrequired

The origin of the movement request

origin.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be collected from

One of:

The location the vehicle should be collected from

origin.​location.​typestringrequired
Value"INTERNAL"
origin.​location.​siteIdstringrequired
Example: "some-site-id"
origin.​readyToCollectFromTimeslotstring(Timeslot)required

The time of day the vehicle should be collected on

Enum"ANYTIME""AM""PM"
origin.​readyToCollectFromDatestring(date)(Date)required

The date the vehicle can be collected from

origin.​estimatedCollectionTimeslotstring(Timeslot)

The estimated collection timeslot for the vehicle

Enum"ANYTIME""AM""PM"
origin.​estimatedCollectionDatestring(date)(Date)

The estimated collection date for the vehicle

destinationobjectrequired

The destination of the movement request

destination.​locationInternalLocation (object) or ExternalLocation (object)required

The location the vehicle should be delivered to

One of:

The location the vehicle should be delivered to

destination.​location.​typestringrequired
Value"INTERNAL"
destination.​location.​siteIdstringrequired
Example: "some-site-id"
destination.​deliveryByTimeslotstring(Timeslot)required

The time of day the vehicle should be delivered on

Enum"ANYTIME""AM""PM"
destination.​deliveryByDatestring(date)(Date)required

The date the vehicle should be delivered by

destination.​deliverOnSpecifiedDateboolean

Whether the vehicle should be delivered on the specified date. Defaults to false.

destination.​estimatedDeliveryTimeslotstring(Timeslot)

The estimated delivery timeslot for the vehicle

Enum"ANYTIME""AM""PM"
destination.​estimatedDeliveryDatestring(date)(Date)

The estimated delivery date for the vehicle

statusstring(VehicleMovementRequestStatus)required

The status of the movement request

Enum"CREATED""SENT_TO_DRIVER""SENT_TO_3PL""SENT_TO_MARKETPLACE""SENT_TO_MULTIPLE_DRIVERS""ACCEPTED""ACCEPTED_SENT_TO_DRIVER""ACCEPTED_SENT_TO_3PL""ACCEPTED_SENT_TO_MARKETPLACE""PARTIALLY_PLANNED"
completedOnstring(datetime)(DateTime)

The date that the movement request was completed, if applicable

businessAreastring(BusinessArea)required
Enum"Retail""Fleet"
notesstring

Any important notes relating to the movement request

Example: "Talk to Kevin for keys"
externalIdstring

Any external identifier you want to link with this movement request

Example: "some-external-identifier"
moDelInformationobject

Key information for linking a Jigcar movement request to a MoDel job

transportMethodstring(TransportMethod)required
Enum"DRIVEN""TRANSPORTED"
providerDriverProvider (object) or ThirdPartyLogisticsProvider (object) or MarketplaceProvider (object)
One of:
Response
application/json
{
  "id": "01K4NNVBR6J323BY6X26J62WA5",
  "vehicle": {
    "vin": "string",
    "vrm": "string",
    "make": "Mercedes-Benz",
    "model": "A-Class",
    "modelVariant": "A 180 AMG Line Executive Hatchback"
  },
  "origin": {
    "location": { … },
    "readyToCollectFromTimeslot": "AM",
    "readyToCollectFromDate": "2023-10-29",
    "estimatedCollectionTimeslot": "AM",
    "estimatedCollectionDate": "2023-10-29"
  },
  "destination": {
    "location": { … },
    "deliveryByTimeslot": "AM",
    "deliveryByDate": "2023-10-29",
    "deliverOnSpecifiedDate": true,
    "estimatedDeliveryTimeslot": "AM",
    "estimatedDeliveryDate": "2023-10-29"
  },
  "status": "IN_PROGRESS",
  "completedOn": "2025-07-01T09:00:00.000Z",
  "businessArea": "Retail",
  "notes": "Talk to Kevin for keys",
  "externalId": "some-external-identifier",
  "moDelInformation": {
    "pin": "some-model-pin"
  },
  "transportMethod": "DRIVEN",
  "provider": {
    "type": "DRIVER",
    "id": "some-driver-id",
    "firstname": "John",
    "surname": "Wick"
  }
}

Infrastructure

Endpoints for retrieving Logistics specific infrastructure within Jigcar

Operations