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

Get all sites

Request

Retrieves all dealership locations stored within Jigcar

Security
JigcarAPIAuth
curl -i -X GET \
  https://docs.jigcar.com/_mock/openapi-v1/infrastructure/sites \
  -H 'X-Jigcar-API-Key: YOUR_API_KEY_HERE'

Responses

All sites retrieved

Bodyapplication/jsonArray [
idstringread-only

The identifier for the site

Example: "some-site-id"
externalIdstringread-only

The external identifer for the site

Example: "some-external-id"
labelstringread-only

The label for the site

Example: "Kingston Audi"
addressobject(Address)read-only
]
Response
application/json
[
  {
    "id": "some-site-id",
    "externalId": "some-external-id",
    "label": "Kingston Audi",
    "address": { … }
  }
]