Circuit · JSON-LD Context

Getcircuit Com Context

JSON-LD context defining the semantic vocabulary for Getcircuit Com from Circuit.

24 Classes 77 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
getcircuit: https://spoke.com/schema#

Classes

connectCourierSchema connectOrderBatchResponseSchema connectOrderCreateRequestSchema connectOrderIdBatchResponseSchema connectOrderImportRequestSchema connectOrderListResponseSchema connectOrderSchema connectOrderShippingLabelsSchema connectOrderSubmitRequestSchema connectOrderUpdateRequestSchema connectOrderWithdrawRequestSchema connectOrderWithdrawResponseSchema connectPickupLocationSchema customStopPropertySchema dateSchema depotSchema driverSchema operationSchema planSchema routeSchema stopSchema timeOfDaySchema unassignedStopSchema memberSchema

Properties

Property Type Container
id
name string
success list
failed list
address
recipient
packageInfo
deliveryInstructions
orders list
nextPageToken string
createdAt decimal
courier
submitted boolean
submittedAt decimal
progress
readOnly boolean
source string
barcodes list
url string
expiresAt decimal
orderIds list
courierId string
visibleToDrivers boolean
visibleToRecipients boolean
day integer
month integer
year integer
email
phone
displayName
active boolean
depots list
routeOverrides
type string
done boolean
metadata
result
title string
starts reference
depot
distributed boolean
writable boolean
optimization
drivers list
routes list
stopCount decimal
driver
state
plan
driverIdentifier
allowedDriversIdentifiers list
estimatedTravelDuration
estimatedTravelDistance
notes
packageCount
weight
packageLabel
stopPosition
trackingLink
webAppLink string
orderInfo
placeInVehicle
activity string
deliveryInfo
paymentOnDelivery
proofOfAttemptRequirements
route
eta
etaNullReason
timing
optimizationOrder string
customProperties
circuitClientId
hour integer
minute integer
linkedDriverId
roles reference

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://spoke.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "getcircuit": "https://spoke.com/schema#",
    "connectCourierSchema": "getcircuit:connectCourierSchema",
    "id": {
      "@id": "getcircuit:id"
    },
    "name": {
      "@id": "getcircuit:name",
      "@type": "xsd:string"
    },
    "connectOrderBatchResponseSchema": "getcircuit:connectOrderBatchResponseSchema",
    "success": {
      "@id": "getcircuit:success",
      "@container": "@list"
    },
    "failed": {
      "@id": "getcircuit:failed",
      "@container": "@list"
    },
    "connectOrderCreateRequestSchema": "getcircuit:connectOrderCreateRequestSchema",
    "address": {
      "@id": "getcircuit:address"
    },
    "recipient": {
      "@id": "getcircuit:recipient"
    },
    "packageInfo": {
      "@id": "getcircuit:packageInfo"
    },
    "deliveryInstructions": {
      "@id": "getcircuit:deliveryInstructions"
    },
    "connectOrderIdBatchResponseSchema": "getcircuit:connectOrderIdBatchResponseSchema",
    "connectOrderImportRequestSchema": "getcircuit:connectOrderImportRequestSchema",
    "orders": {
      "@id": "getcircuit:orders",
      "@container": "@list"
    },
    "connectOrderListResponseSchema": "getcircuit:connectOrderListResponseSchema",
    "nextPageToken": {
      "@id": "getcircuit:nextPageToken",
      "@type": "xsd:string"
    },
    "connectOrderSchema": "getcircuit:connectOrderSchema",
    "createdAt": {
      "@id": "getcircuit:createdAt",
      "@type": "xsd:decimal"
    },
    "courier": {
      "@id": "getcircuit:courier"
    },
    "submitted": {
      "@id": "getcircuit:submitted",
      "@type": "xsd:boolean"
    },
    "submittedAt": {
      "@id": "getcircuit:submittedAt",
      "@type": "xsd:decimal"
    },
    "progress": {
      "@id": "getcircuit:progress"
    },
    "readOnly": {
      "@id": "getcircuit:readOnly",
      "@type": "xsd:boolean"
    },
    "source": {
      "@id": "getcircuit:source",
      "@type": "xsd:string"
    },
    "barcodes": {
      "@id": "getcircuit:barcodes",
      "@container": "@list"
    },
    "connectOrderShippingLabelsSchema": "getcircuit:connectOrderShippingLabelsSchema",
    "url": {
      "@id": "getcircuit:url",
      "@type": "xsd:string"
    },
    "expiresAt": {
      "@id": "getcircuit:expiresAt",
      "@type": "xsd:decimal"
    },
    "connectOrderSubmitRequestSchema": "getcircuit:connectOrderSubmitRequestSchema",
    "orderIds": {
      "@id": "getcircuit:orderIds",
      "@container": "@list"
    },
    "courierId": {
      "@id": "getcircuit:courierId",
      "@type": "xsd:string"
    },
    "connectOrderUpdateRequestSchema": "getcircuit:connectOrderUpdateRequestSchema",
    "connectOrderWithdrawRequestSchema": "getcircuit:connectOrderWithdrawRequestSchema",
    "connectOrderWithdrawResponseSchema": "getcircuit:connectOrderWithdrawResponseSchema",
    "connectPickupLocationSchema": "getcircuit:connectPickupLocationSchema",
    "customStopPropertySchema": "getcircuit:customStopPropertySchema",
    "visibleToDrivers": {
      "@id": "getcircuit:visibleToDrivers",
      "@type": "xsd:boolean"
    },
    "visibleToRecipients": {
      "@id": "getcircuit:visibleToRecipients",
      "@type": "xsd:boolean"
    },
    "dateSchema": "getcircuit:dateSchema",
    "day": {
      "@id": "getcircuit:day",
      "@type": "xsd:integer"
    },
    "month": {
      "@id": "getcircuit:month",
      "@type": "xsd:integer"
    },
    "year": {
      "@id": "getcircuit:year",
      "@type": "xsd:integer"
    },
    "depotSchema": "getcircuit:depotSchema",
    "driverSchema": "getcircuit:driverSchema",
    "email": {
      "@id": "getcircuit:email"
    },
    "phone": {
      "@id": "getcircuit:phone"
    },
    "displayName": {
      "@id": "getcircuit:displayName"
    },
    "active": {
      "@id": "getcircuit:active",
      "@type": "xsd:boolean"
    },
    "depots": {
      "@id": "getcircuit:depots",
      "@container": "@list"
    },
    "routeOverrides": {
      "@id": "getcircuit:routeOverrides"
    },
    "operationSchema": "getcircuit:operationSchema",
    "type": {
      "@id": "getcircuit:type",
      "@type": "xsd:string"
    },
    "done": {
      "@id": "getcircuit:done",
      "@type": "xsd:boolean"
    },
    "metadata": {
      "@id": "getcircuit:metadata"
    },
    "result": {
      "@id": "getcircuit:result"
    },
    "planSchema": "getcircuit:planSchema",
    "title": {
      "@id": "getcircuit:title",
      "@type": "xsd:string"
    },
    "starts": {
      "@id": "getcircuit:starts",
      "@type": "@id"
    },
    "depot": {
      "@id": "getcircuit:depot"
    },
    "distributed": {
      "@id": "getcircuit:distributed",
      "@type": "xsd:boolean"
    },
    "writable": {
      "@id": "getcircuit:writable",
      "@type": "xsd:boolean"
    },
    "optimization": {
      "@id": "getcircuit:optimization"
    },
    "drivers": {
      "@id": "getcircuit:drivers",
      "@container": "@list"
    },
    "routes": {
      "@id": "getcircuit:routes",
      "@container": "@list"
    },
    "routeSchema": "getcircuit:routeSchema",
    "stopCount": {
      "@id": "getcircuit:stopCount",
      "@type": "xsd:decimal"
    },
    "driver": {
      "@id": "getcircuit:driver"
    },
    "state": {
      "@id": "getcircuit:state"
    },
    "plan": {
      "@id": "getcircuit:plan"
    },
    "stopSchema": "getcircuit:stopSchema",
    "driverIdentifier": {
      "@id": "getcircuit:driverIdentifier"
    },
    "allowedDriversIdentifiers": {
      "@id": "getcircuit:allowedDriversIdentifiers",
      "@container": "@list"
    },
    "estimatedTravelDuration": {
      "@id": "getcircuit:estimatedTravelDuration"
    },
    "estimatedTravelDistance": {
      "@id": "getcircuit:estimatedTravelDistance"
    },
    "notes": {
      "@id": "getcircuit:notes"
    },
    "packageCount": {
      "@id": "getcircuit:packageCount"
    },
    "weight": {
      "@id": "getcircuit:weight"
    },
    "packageLabel": {
      "@id": "getcircuit:packageLabel"
    },
    "stopPosition": {
      "@id": "getcircuit:stopPosition"
    },
    "trackingLink": {
      "@id": "getcircuit:trackingLink"
    },
    "webAppLink": {
      "@id": "getcircuit:webAppLink",
      "@type": "xsd:string"
    },
    "orderInfo": {
      "@id": "getcircuit:orderInfo"
    },
    "placeInVehicle": {
      "@id": "getcircuit:placeInVehicle"
    },
    "activity": {
      "@id": "getcircuit:activity",
      "@type": "xsd:string"
    },
    "deliveryInfo": {
      "@id": "getcircuit:deliveryInfo"
    },
    "paymentOnDelivery": {
      "@id": "getcircuit:paymentOnDelivery"
    },
    "proofOfAttemptRequirements": {
      "@id": "getcircuit:proofOfAttemptRequirements"
    },
    "route": {
      "@id": "getcircuit:route"
    },
    "eta": {
      "@id": "getcircuit:eta"
    },
    "etaNullReason": {
      "@id": "getcircuit:etaNullReason"
    },
    "timing": {
      "@id": "getcircuit:timing"
    },
    "optimizationOrder": {
      "@id": "getcircuit:optimizationOrder",
      "@type": "xsd:string"
    },
    "customProperties": {
      "@id": "getcircuit:customProperties"
    },
    "circuitClientId": {
      "@id": "getcircuit:circuitClientId"
    },
    "timeOfDaySchema": "getcircuit:timeOfDaySchema",
    "hour": {
      "@id": "getcircuit:hour",
      "@type": "xsd:integer"
    },
    "minute": {
      "@id": "getcircuit:minute",
      "@type": "xsd:integer"
    },
    "unassignedStopSchema": "getcircuit:unassignedStopSchema",
    "memberSchema": "getcircuit:memberSchema",
    "linkedDriverId": {
      "@id": "getcircuit:linkedDriverId"
    },
    "roles": {
      "@id": "getcircuit:roles",
      "@type": "@id"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Circuit API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Circuit's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-29) from openapi/openapi-connect-v1.json, openapi/openapi-v0.2b.json, openapi/openapi-v1.json.",
  "dcterms:created": "2026-10-29",
  "dcterms:source": [
    "openapi/openapi-connect-v1.json",
    "openapi/openapi-v0.2b.json",
    "openapi/openapi-v1.json"
  ]
}