{"items":[{"type":"link","label":"Jigcar Public APIs","link":"/openapi-v1","routeSlug":"/openapi-v1","content":{"contentType":"overview","meta":{"name":"Jigcar Public APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi-v1.json","url":"/_bundle/openapi-v1.json?download"},{"kind":"download","label":"openapi-v1.yaml","url":"/_bundle/openapi-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://jigcar.com/","url":"https://jigcar.com/"},{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"engineering@jigcar.com","label":"engineering@jigcar.com","withCopyButton":true,"copyContent":"engineering@jigcar.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"MIT","url":"https://opensource.org/license/mit/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Jigcar Public APIs (1.0.0-alpha)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Public APIs for interacting with Jigcar"}],"sectionId":"/openapi-v1"}],"sectionId":"/openapi-v1"}]}]}},{"type":"group","label":"Movement Requests","link":"/openapi-v1/movement-requests","routeSlug":"/openapi-v1/movement-requests","items":[{"label":"Create vehicle movement request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/movement-requests/createvehiclemovementrequestinplanningpool","routeSlug":"/openapi-v1/movement-requests/createvehiclemovementrequestinplanningpool","metadata":{"seo":{"title":"Create vehicle movement request","description":"Creates a movement request for the provided vehicle and sends it to an internal planning pool"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVehicleMovementRequestInPlanningPool","name":"Create vehicle movement request","isWebhook":false,"pointer":"/paths/~1movement-requests~1create-in-planning-pool/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create vehicle movement request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a movement request for the provided vehicle and sends it to an internal planning pool"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateVehicleMovementRequestBody"}},"schemaId":"components/schemas/CreateVehicleMovementRequestBody","pointer":"/paths/~1movement-requests~1create-in-planning-pool/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/movement-requests/create-in-planning-pool","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateVehicleMovementRequestBody"}},"responseCodes":["201","400","404"],"pointer":"/movement-requests/create-in-planning-pool","href":"movement-requests/createvehiclemovementrequestinplanningpool","openApiOperationId":"createVehicleMovementRequestInPlanningPool","summary":"Create vehicle movement request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"schemaId":"components/schemas/CreateVehicleMovementRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateVehicleMovementRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}},"schemaId":"components/schemas/VehicleMovementRequest"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"}],"pointer":"/paths/~1movement-requests~1create-in-planning-pool/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/VehicleMovementRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/movement-requests/createvehiclemovementrequestinplanningpool"}],"panels":[]}]},"httpPath":"/movement-requests/create-in-planning-pool"},{"label":"Create vehicle movement request for direct dispatch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/movement-requests/createvehiclemovementrequestwith3pl","routeSlug":"/openapi-v1/movement-requests/createvehiclemovementrequestwith3pl","metadata":{"seo":{"title":"Create vehicle movement request for direct dispatch","description":"Creates a movement request for the provided vehicle and dispatches it directly to the chosen third-partylogistics provider, bypassing the internal planning pool. The provider must exist and must support therequested transport method. Possible 400 error codes include THIRD_PARTY_LOGISTICS_PROVIDER_NOT_FOUND(the supplied id does not match a 3PL) and PROVIDER_CANNOT_FULFIL_MOVEMENT (the 3PL does not supportthe requested transport method)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVehicleMovementRequestWith3pl","name":"Create vehicle movement request for direct dispatch","isWebhook":false,"pointer":"/paths/~1movement-requests~1create-with-3pl/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create vehicle movement request for direct dispatch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a movement request for the provided vehicle and dispatches it directly to the chosen third-party"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logistics provider, bypassing the internal planning pool. The provider must exist and must support the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requested transport method. Possible 400 error codes include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"THIRD_PARTY_LOGISTICS_PROVIDER_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the supplied id does not match a 3PL) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROVIDER_CANNOT_FULFIL_MOVEMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the 3PL does not support"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the requested transport method)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateVehicleMovementRequestWith3plBody"}},"schemaId":"components/schemas/CreateVehicleMovementRequestWith3plBody","pointer":"/paths/~1movement-requests~1create-with-3pl/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/movement-requests/create-with-3pl","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateVehicleMovementRequestWith3plBody"}},"responseCodes":["201","400","404"],"pointer":"/movement-requests/create-with-3pl","href":"movement-requests/createvehiclemovementrequestwith3pl","openApiOperationId":"createVehicleMovementRequestWith3pl","summary":"Create vehicle movement request for direct dispatch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"schemaId":"components/schemas/CreateVehicleMovementRequestWith3plBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateVehicleMovementRequestWith3plBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}},"schemaId":"components/schemas/VehicleMovementRequest"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"}],"pointer":"/paths/~1movement-requests~1create-with-3pl/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/VehicleMovementRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/movement-requests/createvehiclemovementrequestwith3pl"}],"panels":[]}]},"httpPath":"/movement-requests/create-with-3pl"},{"label":"Get vehicle movement request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/movement-requests/getvehiclemovementrequestbyid","routeSlug":"/openapi-v1/movement-requests/getvehiclemovementrequestbyid","metadata":{"seo":{"title":"Get vehicle movement request","description":"Retrieves the current state of a vehicle movement request by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVehicleMovementRequestById","name":"Get vehicle movement request","isWebhook":false,"pointer":"/paths/~1movement-requests~1{requestId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vehicle movement request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the current state of a vehicle movement request by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"requestId","in":"path","schemaId":"schema_9","description":"Identifier for a movement request","required":true}],"pointer":"/paths/~1movement-requests~1{requestId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/movement-requests/{requestId}","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[{"name":"requestId","in":"path","required":true,"example":"01K4NNVBR6J323BY6X26J62WA5","schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/movement-requests/{requestId}","href":"movement-requests/getvehiclemovementrequestbyid","openApiOperationId":"getVehicleMovementRequestById","summary":"Get vehicle movement request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vehicle movement request retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}},"schemaId":"components/schemas/VehicleMovementRequest"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1movement-requests~1{requestId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VehicleMovementRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/movement-requests/getvehiclemovementrequestbyid"}],"panels":[]}]},"httpPath":"/movement-requests/{requestId}"},{"label":"Update vehicle movement request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/movement-requests/updatevehiclemovementrequestbyid","routeSlug":"/openapi-v1/movement-requests/updatevehiclemovementrequestbyid","metadata":{"seo":{"title":"Update vehicle movement request","description":"Updates specific details of a vehicle movement request by id. Omitting a property will leave it unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVehicleMovementRequestById","name":"Update vehicle movement request","isWebhook":false,"pointer":"/paths/~1movement-requests~1{requestId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update vehicle movement request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates specific details of a vehicle movement request by id. Omitting a property will leave it unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"requestId","in":"path","schemaId":"schema_9","description":"Identifier for a movement request","required":true}],"pointer":"/paths/~1movement-requests~1{requestId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateVehicleMovementRequestBody"}},"schemaId":"components/schemas/UpdateVehicleMovementRequestBody","pointer":"/paths/~1movement-requests~1{requestId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/movement-requests/{requestId}","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[{"name":"requestId","in":"path","required":true,"example":"01K4NNVBR6J323BY6X26J62WA5","schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateVehicleMovementRequestBody"}},"responseCodes":["200","400","404","500"],"pointer":"/movement-requests/{requestId}","href":"movement-requests/updatevehiclemovementrequestbyid","openApiOperationId":"updateVehicleMovementRequestById","summary":"Update vehicle movement request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"schemaId":"components/schemas/UpdateVehicleMovementRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateVehicleMovementRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vehicle movement request updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}},"schemaId":"components/schemas/VehicleMovementRequest"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1movement-requests~1{requestId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VehicleMovementRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleMovementRequest"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/movement-requests/updatevehiclemovementrequestbyid"}],"panels":[]}]},"httpPath":"/movement-requests/{requestId}"}],"content":{"contentType":"group","meta":{"name":"Movement Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Movement Requests","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for creating/retrieving Jigcar movement requests"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/movement-requests/create-in-planning-pool","summary":"Create vehicle movement request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/movement-requests/createvehiclemovementrequestinplanningpool","deprecated":false},{"title":"/movement-requests/create-with-3pl","summary":"Create vehicle movement request for direct dispatch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/movement-requests/createvehiclemovementrequestwith3pl","deprecated":false},{"title":"/movement-requests/{requestId}","summary":"Get vehicle movement request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/movement-requests/getvehiclemovementrequestbyid","deprecated":false},{"title":"/movement-requests/{requestId}","summary":"Update vehicle movement request","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/movement-requests/updatevehiclemovementrequestbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Infrastructure","link":"/openapi-v1/infrastructure","routeSlug":"/openapi-v1/infrastructure","items":[{"label":"Get all sites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/infrastructure/getallsites","routeSlug":"/openapi-v1/infrastructure/getallsites","metadata":{"seo":{"title":"Get all sites","description":"Retrieves all dealership locations stored within Jigcar"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllSites","name":"Get all sites","isWebhook":false,"pointer":"/paths/~1infrastructure~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all dealership locations stored within Jigcar"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/infrastructure/sites","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/infrastructure/sites","href":"infrastructure/getallsites","openApiOperationId":"getAllSites","summary":"Get all sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All sites retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1infrastructure~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/infrastructure/getallsites"}],"panels":[]}]},"httpPath":"/infrastructure/sites"},{"label":"Get all third-party logistics providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/infrastructure/getall3pls","routeSlug":"/openapi-v1/infrastructure/getall3pls","metadata":{"seo":{"title":"Get all third-party logistics providers","description":"Retrieves all third-party logistics providers configured for the caller's profile. Use the returned idswith POST /v1/movement-requests/create-with-3pl to dispatch movements to a specific provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAll3pls","name":"Get all third-party logistics providers","isWebhook":false,"pointer":"/paths/~1infrastructure~1providers~1third-party/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all third-party logistics providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all third-party logistics providers configured for the caller's profile. Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/movement-requests/create-with-3pl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to dispatch movements to a specific provider."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/infrastructure/providers/third-party","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/infrastructure/providers/third-party","href":"infrastructure/getall3pls","openApiOperationId":"getAll3pls","summary":"Get all third-party logistics providers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All 3PLs retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1infrastructure~1providers~1third-party/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/infrastructure/getall3pls"}],"panels":[]}]},"httpPath":"/infrastructure/providers/third-party"}],"content":{"contentType":"group","meta":{"name":"Infrastructure"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Infrastructure","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for retrieving Logistics specific infrastructure within Jigcar"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/infrastructure/sites","summary":"Get all sites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/infrastructure/getallsites","deprecated":false},{"title":"/infrastructure/providers/third-party","summary":"Get all third-party logistics providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/infrastructure/getall3pls","deprecated":false}]}]}]}]}},{"type":"group","label":"Prep Jobs","link":"/openapi-v1/prep-jobs","routeSlug":"/openapi-v1/prep-jobs","items":[{"label":"Mark prep job as appraised","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/prep-jobs/moveprepjobtoappraised","routeSlug":"/openapi-v1/prep-jobs/moveprepjobtoappraised","metadata":{"seo":{"title":"Mark prep job as appraised","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"movePrepJobToAppraised","name":"Mark prep job as appraised","isWebhook":false,"pointer":"/paths/~1prep-jobs~1appraised/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark prep job as appraised","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"vin","in":"query","schemaId":"schema_12","description":"Vehicle Identification Number"},{"name":"vrm","in":"query","schemaId":"schema_13","description":"Vehicle Registration Mark"}],"pointer":"/paths/~1prep-jobs~1appraised/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/prep-jobs/appraised","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[{"name":"vin","in":"query","example":"1C6RR7FT9ES349880","schemaId":"schema_12"},{"name":"vrm","in":"query","example":"SX05CWO","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/prep-jobs/appraised","href":"prep-jobs/moveprepjobtoappraised","openApiOperationId":"movePrepJobToAppraised","summary":"Mark prep job as appraised"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Prep job transitioned to APPRAISED","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrepJob"}},"schemaId":"components/schemas/PrepJob"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the required module is not enabled for the calling profile."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1prep-jobs~1appraised/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrepJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrepJob"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prep-jobs/moveprepjobtoappraised"}],"panels":[]}]},"httpPath":"/prep-jobs/appraised"},{"label":"Mark prep job as awaiting a movement request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/prep-jobs/moveprepjobtopendingmovementrequest","routeSlug":"/openapi-v1/prep-jobs/moveprepjobtopendingmovementrequest","metadata":{"seo":{"title":"Mark prep job as awaiting a movement request","description":"Transitions a prep job to the OUTBOUND stage with substage PENDING_MOVEMENT_REQUEST — the vehiclehas finished preparation (for example, photography is complete) but its outbound movement has notbeen requested yet. The job is promoted to OUTBOUND.SCHEDULED automatically once the movement iscreated. Lookup by VIN or VRM (VIN takes precedence if both provided); at least one must beprovided. The VRM is matched exactly as stored, with no whitespace normalisation — a VRM thatdiffers only in spacing will not match and returns 404. Repeating the call while the job is alreadyawaiting a movement returns 200 without any effect; calling it once a movement exists returns 400."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"movePrepJobToPendingMovementRequest","name":"Mark prep job as awaiting a movement request","isWebhook":false,"pointer":"/paths/~1prep-jobs~1pending-movement-request/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark prep job as awaiting a movement request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transitions a prep job to the OUTBOUND stage with substage PENDING_MOVEMENT_REQUEST — the vehicle"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has finished preparation (for example, photography is complete) but its outbound movement has not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"been requested yet. The job is promoted to OUTBOUND.SCHEDULED automatically once the movement is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created. Lookup by VIN or VRM (VIN takes precedence if both provided); at least one must be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided. The VRM is matched exactly as stored, with no whitespace normalisation — a VRM that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"differs only in spacing will not match and returns 404. Repeating the call while the job is already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"awaiting a movement returns 200 without any effect; calling it once a movement exists returns 400."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"vin","in":"query","schemaId":"schema_12","description":"Vehicle Identification Number"},{"name":"vrm","in":"query","schemaId":"schema_13","description":"Vehicle Registration Mark (matched exactly as stored)"}],"pointer":"/paths/~1prep-jobs~1pending-movement-request/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/prep-jobs/pending-movement-request","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[{"name":"vin","in":"query","example":"1C6RR7FT9ES349880","schemaId":"schema_12"},{"name":"vrm","in":"query","example":"SX05CWO","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","403","404","500"],"pointer":"/prep-jobs/pending-movement-request","href":"prep-jobs/moveprepjobtopendingmovementrequest","openApiOperationId":"movePrepJobToPendingMovementRequest","summary":"Mark prep job as awaiting a movement request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prep job transitioned to (or already in) OUTBOUND.PENDING_MOVEMENT_REQUEST"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrepJob"}},"schemaId":"components/schemas/PrepJob"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the required module is not enabled for the calling profile."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}},"schemaId":"components/schemas/NotFoundError"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1prep-jobs~1pending-movement-request/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrepJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrepJob"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/NotFoundError"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prep-jobs/moveprepjobtopendingmovementrequest"}],"panels":[]}]},"httpPath":"/prep-jobs/pending-movement-request"},{"label":"Create an inbound-pending prep job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi-v1/prep-jobs/createinboundpendingprepjob","routeSlug":"/openapi-v1/prep-jobs/createinboundpendingprepjob","metadata":{"seo":{"title":"Create an inbound-pending prep job","description":"Creates a prep job for a vehicle that has been purchased (for example at auction) but has nodestination prep site chosen yet. The job is created in stage INBOUND with substagePENDING_MOVEMENT_REQUEST and is parked until a prep site is assigned in Jigcar, at which pointan inbound movement is created and the job moves onto that site's board."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInboundPendingPrepJob","name":"Create an inbound-pending prep job","isWebhook":false,"pointer":"/paths/~1prep-jobs~1inbound-pending/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an inbound-pending prep job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a prep job for a vehicle that has been purchased (for example at auction) but has no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"destination prep site chosen yet. The job is created in stage INBOUND with substage"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_MOVEMENT_REQUEST and is parked until a prep site is assigned in Jigcar, at which point"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an inbound movement is created and the job moves onto that site's board."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vehicle.vin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vehicle.vrm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided; when only a VRM is given a VIN"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"placeholder is derived from it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purchaseDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a calendar date interpreted in the caller's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timezone. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessArea"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be one of the defaults (Retail, Fleet) or a custom business area"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configured for the organisation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Posting a vehicle that already has an active prep job returns 409 Conflict without creating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"anything, so repeating the call for the same purchase is a safe no-op."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JigcarAPIAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInboundPendingPrepJobBody"}},"schemaId":"components/schemas/CreateInboundPendingPrepJobBody","pointer":"/paths/~1prep-jobs~1inbound-pending/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/prep-jobs/inbound-pending","servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JigcarAPIAuth","type":"apiKey","name":"X-Jigcar-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateInboundPendingPrepJobBody"}},"responseCodes":["201","400","403","409","500"],"pointer":"/prep-jobs/inbound-pending","href":"prep-jobs/createinboundpendingprepjob","openApiOperationId":"createInboundPendingPrepJob","summary":"Create an inbound-pending prep job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi-v1","description":"Mock server","isMockServer":true},{"url":"https://public-api.jigcar.com/v1"}],"schemaId":"components/schemas/CreateInboundPendingPrepJobBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInboundPendingPrepJobBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Inbound-pending prep job created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrepJob"}},"schemaId":"components/schemas/PrepJob"},{"code":"400","description":"Bad request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the required module is not enabled for the calling profile."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict — an active resource already exists for the given identifiers."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}},"schemaId":"components/schemas/ApiFailure500Response"}],"pointer":"/paths/~1prep-jobs~1inbound-pending/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PrepJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrepJob"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/ApiFailure500Response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiFailure500Response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prep-jobs/createinboundpendingprepjob"}],"panels":[]}]},"httpPath":"/prep-jobs/inbound-pending"}],"content":{"contentType":"group","meta":{"name":"Prep Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prep Jobs","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for managing prep jobs at prep sites"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/prep-jobs/appraised","summary":"Mark prep job as appraised","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/prep-jobs/moveprepjobtoappraised","deprecated":false},{"title":"/prep-jobs/pending-movement-request","summary":"Mark prep job as awaiting a movement request","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/prep-jobs/moveprepjobtopendingmovementrequest","deprecated":false},{"title":"/prep-jobs/inbound-pending","summary":"Create an inbound-pending prep job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prep-jobs/createinboundpendingprepjob","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApiFailure500Response":{"id":"components/schemas/ApiFailure500Response","kind":"json-schema","title":"ApiFailure500Response","data":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INTERNAL_SERVER_ERROR"]},"message":{"type":"string","example":"We encountered an unexpected error trying to service your request. Please try again later."}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["line1","postcode"],"properties":{"line1":{"type":"string","description":"1st line of the address","example":"123 Main St"},"line2":{"type":"string","description":"2nd line of the address"},"line3":{"type":"string","description":"3rd line of the address"},"postcode":{"type":"string","description":"Postal code of the addres","example":"GU1 4UT"}}}},"components/schemas/Site":{"id":"components/schemas/Site","kind":"json-schema","title":"Site","data":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","example":"some-site-id","description":"The identifier for the site"},"externalId":{"readOnly":true,"type":"string","example":"some-external-id","description":"The external identifer for the site"},"label":{"readOnly":true,"type":"string","example":"Kingston Audi","description":"The label for the site"},"address":{"readOnly":true,"$ref":"#/components/schemas/Address"}}}},"components/schemas/Vehicle":{"id":"components/schemas/Vehicle","kind":"json-schema","title":"Vehicle","data":{"type":"object","properties":{"vin":{"type":"string","description":"The chassis number of the vehicle"},"vrm":{"type":"string","description":"The car reg of the vehicle"},"externalVehicleId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own reference for the vehicle, such as a stock number. Distinct from the request's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which references the movement rather than the vehicle. Not searchable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 64 characters alongside a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vrm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the vehicle has neither, this becomes its only identifier and must be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"19 characters or fewer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a longer one is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_VIN_OR_VRM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"STOCK-12345","maxLength":64},"make":{"type":"string","description":"The make of the vehicle","example":"Mercedes-Benz"},"model":{"type":"string","description":"The model of the vehicle","example":"A-Class"},"modelVariant":{"description":"the extended description of the vehicle","example":"A 180 AMG Line Executive Hatchback","type":"string"}}}},"components/schemas/Timeslot":{"id":"components/schemas/Timeslot","kind":"json-schema","title":"Timeslot","data":{"type":"string","example":"AM","enum":["ANYTIME","AM","PM"]}},"components/schemas/VehicleMovementRequestStatus":{"id":"components/schemas/VehicleMovementRequestStatus","kind":"json-schema","title":"VehicleMovementRequestStatus","data":{"type":"string","example":"IN_PROGRESS","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","PLANNED","IN_PROGRESS","DELIVERED","ABORTED"]}},"components/schemas/TransportMethod":{"id":"components/schemas/TransportMethod","kind":"json-schema","title":"TransportMethod","data":{"type":"string","example":"DRIVEN","enum":["DRIVEN","TRANSPORTED"]}},"components/schemas/BusinessArea":{"id":"components/schemas/BusinessArea","kind":"json-schema","title":"BusinessArea","data":{"type":"string","example":"Retail","enum":["Retail","Fleet"]}},"components/schemas/InternalLocation":{"id":"components/schemas/InternalLocation","kind":"json-schema","title":"InternalLocation","data":{"type":"object","required":["type","siteId"],"properties":{"type":{"type":"string","enum":["INTERNAL"]},"siteId":{"type":"string","example":"some-site-id"}}}},"components/schemas/ExternalLocation":{"id":"components/schemas/ExternalLocation","kind":"json-schema","title":"ExternalLocation","data":{"type":"object","required":["type","address","contactDetails"],"properties":{"type":{"type":"string","enum":["EXTERNAL"]},"externalLocationType":{"type":"string","description":"whether the external location is a customers address or external organisation location","enum":["CUSTOMER","ORGANISATION"]},"address":{"$ref":"#/components/schemas/Address"},"contactDetails":{"type":"object","required":["name","phoneNumber"],"properties":{"name":{"type":"string","description":"The location contacts name"},"phoneNumber":{"type":"string","description":"the location contacts phone number"}}}}}},"components/schemas/DriverProvider":{"id":"components/schemas/DriverProvider","kind":"json-schema","title":"DriverProvider","data":{"type":"object","required":["type","id","firstname","surname"],"properties":{"type":{"type":"string","enum":["DRIVER"]},"id":{"type":"string","example":"some-driver-id","description":"The driver's id"},"firstname":{"type":"string","description":"The driver's first name","example":"John"},"surname":{"type":"string","description":"The driver's surname","example":"Wick"}}}},"components/schemas/ThirdPartyLogisticsProvider":{"id":"components/schemas/ThirdPartyLogisticsProvider","kind":"json-schema","title":"ThirdPartyLogisticsProvider","data":{"type":"object","required":["type","id","name","primaryContactInformation","supportedTransportTypes","doesWeekendDelivery"],"properties":{"type":{"type":"string","enum":["THIRD_PARTY_LOGISTICS"]},"id":{"type":"string","example":"some-third-party-id","description":"The logistic providers id"},"name":{"type":"string","description":"The logistics providers name","example":"ACME Ltd"},"primaryContactInformation":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","description":"The primary contacts name","example":"Jane Doe"},"email":{"type":"string","description":"The primary contacts email address","example":"jane.doe@acme.com"}}},"supportedTransportTypes":{"type":"array","description":"The transport methods this 3PL is willing/able to fulfil","items":{"$ref":"#/components/schemas/TransportMethod"}},"doesWeekendDelivery":{"type":"boolean","description":"Whether this 3PL delivers on weekends","example":true}}}},"components/schemas/ThirdPartyLogisticsProviderListItem":{"id":"components/schemas/ThirdPartyLogisticsProviderListItem","kind":"json-schema","title":"ThirdPartyLogisticsProviderListItem","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List item returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v1/infrastructure/providers/third-party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identical to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThirdPartyLogisticsProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" discriminator (every item in the list is implicitly a 3PL)."},"children":[]}]}]}],"type":"object","required":["id","name","primaryContactInformation","supportedTransportTypes","doesWeekendDelivery"],"properties":{"id":{"type":"string","example":"some-third-party-id","description":"The logistic providers id"},"name":{"type":"string","description":"The logistics providers name","example":"ACME Ltd"},"primaryContactInformation":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","description":"The primary contacts name","example":"Jane Doe"},"email":{"type":"string","description":"The primary contacts email address","example":"jane.doe@acme.com"}}},"supportedTransportTypes":{"type":"array","description":"The transport methods this 3PL is willing/able to fulfil","items":{"$ref":"#/components/schemas/TransportMethod"}},"doesWeekendDelivery":{"type":"boolean","description":"Whether this 3PL delivers on weekends","example":true}}}},"components/schemas/MarketplaceProvider":{"id":"components/schemas/MarketplaceProvider","kind":"json-schema","title":"MarketplaceProvider","data":{"type":"object","required":["type","name","externalId"],"properties":{"type":{"type":"string","enum":["MARKETPLACE"]},"name":{"type":"string","description":"The marketplace provider name","example":"ACME Marketplace"},"externalId":{"type":"string","description":"The external identifier for the movement with the marketplace provider","example":"some-external-id"}}}},"components/schemas/Date":{"id":"components/schemas/Date","kind":"json-schema","title":"Date","data":{"type":"string","format":"date","example":"2023-10-29"}},"components/schemas/DateTime":{"id":"components/schemas/DateTime","kind":"json-schema","title":"DateTime","data":{"type":"string","format":"datetime","example":"2025-07-01T09:00:00.000Z"}},"components/schemas/Money":{"id":"components/schemas/Money","kind":"json-schema","title":"Money","data":{"type":"object","description":"A monetary amount expressed in minor units (e.g. cents/pence).","required":["centAmount","currencyCode"],"properties":{"centAmount":{"type":"integer","description":"The amount expressed in the smallest unit of the currency.","example":12500},"currencyCode":{"type":"string","description":"ISO 4217 currency code.","example":"GBP"}}}},"components/schemas/Email":{"id":"components/schemas/Email","kind":"json-schema","title":"Email","data":{"description":"An email address","type":"string","format":"email","example":"jigcar@example.com"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"type":"string","example":"INVALID_VRM","description":"Machine-readable error code"},"message":{"type":"string","example":"The provided VRM is invalid","description":"Human-readable error message"}}}},"components/schemas/NotFoundError":{"id":"components/schemas/NotFoundError","kind":"json-schema","title":"NotFoundError","data":{"type":"object","properties":{"code":{"type":"string","example":"VEHICLE_MOVEMENT_REQUEST_NOT_FOUND","description":"Machine-readable error code"},"message":{"type":"string","example":"A vehicle movement request with the provided ID cannot be found","description":"Human-readable error message"}}}},"components/schemas/OriginForCreate":{"id":"components/schemas/OriginForCreate","kind":"json-schema","title":"OriginForCreate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origin of the movement request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readyToCollectFromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readyToCollectFromTimeslot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional. Omitting them means \"the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vehicle is ready now\": the date defaults to today at the origin site, and the timeslot to whichever slot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that site's local clock is currently in. When the site's timezone cannot be resolved from its country"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code the timeslot falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANYTIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", rather than bucketing against a clock we cannot place."},"children":[]}]}]}],"type":"object","required":["location"],"properties":{"location":{"description":"The location the vehicle should be collected from","oneOf":[{"$ref":"#/components/schemas/InternalLocation"},{"$ref":"#/components/schemas/ExternalLocation"}]},"readyToCollectFromTimeslot":{"description":"The time of day the vehicle should be collected on. Defaults to the origin site's current timeslot.","$ref":"#/components/schemas/Timeslot"},"readyToCollectFromDate":{"description":"The date the vehicle can be collected from. Defaults to today at the origin site.","$ref":"#/components/schemas/Date"}}}},"components/schemas/OriginForCreateWith3pl":{"id":"components/schemas/OriginForCreateWith3pl","kind":"json-schema","title":"OriginForCreateWith3pl","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin shape for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/movement-requests/create-with-3pl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OriginForCreate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowCollectionDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which is only meaningful when dispatching to a 3PL."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/OriginForCreate"},{"type":"object","properties":{"allowCollectionDateAdjustment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, instead of rejecting a same-day collection requested after the 3PL's midday cutoff, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"collection date is shifted forward to the next working day. Defaults to false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ignored when the chosen 3PL is self notifying — no collection date is rejected, so nothing shifts."},"children":[]}]}]}]}}}]}},"components/schemas/OriginForUpdate":{"id":"components/schemas/OriginForUpdate","kind":"json-schema","title":"OriginForUpdate","data":{"description":"The origin of the movement request","type":"object","properties":{"location":{"description":"The location the vehicle should be collected from","oneOf":[{"$ref":"#/components/schemas/InternalLocation"},{"$ref":"#/components/schemas/ExternalLocation"}]},"readyToCollectFromTimeslot":{"description":"The time of day the vehicle should be collected on","$ref":"#/components/schemas/Timeslot"},"readyToCollectFromDate":{"description":"The date the vehicle can be collected from","$ref":"#/components/schemas/Date"}}}},"components/schemas/DestinationForCreate":{"id":"components/schemas/DestinationForCreate","kind":"json-schema","title":"DestinationForCreate","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination of the movement request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply the deadline's time of day as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you have one. It sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByTimeslot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(before noon is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", noon onwards is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and is also kept verbatim as the delivery hours, so a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deadline stays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than being widened to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s 17:00 close."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByTimeslot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always wins over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When neither is given the timeslot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANYTIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["location","deliveryByDate"],"properties":{"location":{"description":"The location the vehicle should be delivered to","oneOf":[{"$ref":"#/components/schemas/InternalLocation"},{"$ref":"#/components/schemas/ExternalLocation"}]},"deliveryByTimeslot":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time of day the vehicle should be delivered on. Derived from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}],"$ref":"#/components/schemas/Timeslot"},"deliveryByDate":{"description":"The date the vehicle should be delivered by","$ref":"#/components/schemas/Date"},"deliveryByTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deadline's time of day, 24-hour "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByTimeslot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is kept as the exact delivery deadline."},"children":[]}]}]}],"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","example":"16:00"},"deliverOnSpecifiedDate":{"description":"Whether the vehicle should be delivered on the specified date. Defaults to false.","type":"boolean"}}}},"components/schemas/DestinationForCreateWith3pl":{"id":"components/schemas/DestinationForCreateWith3pl","kind":"json-schema","title":"DestinationForCreateWith3pl","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination shape for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/movement-requests/create-with-3pl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identical to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DestinationForCreate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowDeliveryDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which is only meaningful when dispatching to a 3PL."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/DestinationForCreate"},{"type":"object","properties":{"allowDeliveryDateAdjustment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, instead of rejecting a delivery date that falls before the 3PL's earliest available, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery date is shifted forward to the earliest the provider can deliver. Defaults to false."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ignored when the chosen 3PL is self notifying — such a provider has no earliest-available window."},"children":[]}]}]}]}}}]}},"components/schemas/DestinationForUpdate":{"id":"components/schemas/DestinationForUpdate","kind":"json-schema","title":"DestinationForUpdate","data":{"description":"The destination of the movement request","type":"object","properties":{"location":{"description":"The location the vehicle should be delivered to","oneOf":[{"$ref":"#/components/schemas/InternalLocation"},{"$ref":"#/components/schemas/ExternalLocation"}]},"deliveryByTimeslot":{"description":"The time of day the vehicle should be delivered on","$ref":"#/components/schemas/Timeslot"},"deliveryByDate":{"description":"The date the vehicle should be delivered by","$ref":"#/components/schemas/Date"},"deliverOnSpecifiedDate":{"description":"Whether the vehicle should be delivered on the specified date.","type":"boolean"}}}},"components/schemas/CreateVehicleMovementRequestBody":{"id":"components/schemas/CreateVehicleMovementRequestBody","kind":"json-schema","title":"CreateVehicleMovementRequestBody","data":{"type":"object","required":["vehicle","origin","destination","businessArea","transportMethod"],"properties":{"vehicle":{"$ref":"#/components/schemas/Vehicle"},"origin":{"$ref":"#/components/schemas/OriginForCreate"},"destination":{"$ref":"#/components/schemas/DestinationForCreate"},"businessArea":{"$ref":"#/components/schemas/BusinessArea"},"notes":{"type":"string","example":"Talk to Kevin for keys","description":"Any important notes relating to the movement request","maxLength":1024},"externalId":{"type":"string","example":"some-external-identifier","description":"Any external identifier you want to link with this movement request"},"confirmedBy":{"type":"string","description":"The person who confirmed the vehicle is on site and available for collection","example":"John Doe","maxLength":128},"requestedBy":{"type":"string","format":"email","description":"Email of the person this movement is being raised for. Replaces the API key identity as the request's creator, so the tracking, delivered and aborted notifications are addressed to them rather than being dropped. Write only: the request stores it as its creator and does not return it.","example":"john.doe@example.com","maxLength":254},"moDelInformation":{"type":"object","description":"Key information for linking a Jigcar movement request to a MoDel job","required":["pin"],"properties":{"pin":{"type":"string","description":"the associated MoDel job pin","example":"some-model-pin"}}},"transportMethod":{"$ref":"#/components/schemas/TransportMethod"}}}},"components/schemas/CreateVehicleMovementRequestWith3plBody":{"id":"components/schemas/CreateVehicleMovementRequestWith3plBody","kind":"json-schema","title":"CreateVehicleMovementRequestWith3plBody","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body shape for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/movement-requests/create-with-3pl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Identical to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateVehicleMovementRequestBody"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyLogisticsProviderId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, and the optional"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin.allowCollectionDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination.allowDeliveryDateAdjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flags that only apply when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispatching to a 3PL. The provided id must reference an existing 3PL and the 3PL must support the requested"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transportMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the 3PL is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"self notifying"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the date windows are not enforced: a collection date in the past, a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same-day collection after the midday cutoff, and a delivery date earlier than the provider's usual lead"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time are all accepted as sent. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" earlier than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readyToCollectFromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still rejected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COLLECT_FROM_BEFORE_DELIVER_BY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","required":["vehicle","origin","destination","businessArea","transportMethod","thirdPartyLogisticsProviderId"],"properties":{"vehicle":{"$ref":"#/components/schemas/Vehicle"},"origin":{"$ref":"#/components/schemas/OriginForCreateWith3pl"},"destination":{"$ref":"#/components/schemas/DestinationForCreateWith3pl"},"businessArea":{"$ref":"#/components/schemas/BusinessArea"},"notes":{"type":"string","example":"Talk to Kevin for keys","description":"Any important notes relating to the movement request","maxLength":1024},"externalId":{"type":"string","example":"some-external-identifier","description":"Any external identifier you want to link with this movement request"},"confirmedBy":{"type":"string","description":"The person who confirmed the vehicle is on site and available for collection","example":"John Doe","maxLength":128},"requestedBy":{"type":"string","format":"email","description":"Email of the person this movement is being raised for. Replaces the API key identity as the request's creator, so the tracking, delivered and aborted notifications are addressed to them rather than being dropped. Write only: the request stores it as its creator and does not return it.","example":"john.doe@example.com","maxLength":254},"moDelInformation":{"type":"object","description":"Key information for linking a Jigcar movement request to a MoDel job","required":["pin"],"properties":{"pin":{"type":"string","description":"the associated MoDel job pin","example":"some-model-pin"}}},"transportMethod":{"$ref":"#/components/schemas/TransportMethod"},"thirdPartyLogisticsProviderId":{"type":"string","description":"The id of the 3PL that should fulfil this movement","example":"some-third-party-id"}}}},"components/schemas/UpdateVehicleMovementRequestBody":{"id":"components/schemas/UpdateVehicleMovementRequestBody","kind":"json-schema","title":"UpdateVehicleMovementRequestBody","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body shape for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v1/movement-requests/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the movement is with a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"self notifying"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 3PL, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readyToCollectFromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be moved into the past —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that provider reports the dates it actually worked to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryByDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" earlier than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"readyToCollectFromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COLLECT_FROM_BEFORE_DELIVER_BY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"origin":{"$ref":"#/components/schemas/OriginForUpdate"},"destination":{"$ref":"#/components/schemas/DestinationForUpdate"},"notes":{"type":"string","example":"I left snacks in the glove compartment","description":"Any important notes relating to the movement request","maxLength":1024},"moDelInformation":{"type":"object","description":"Key information for linking a Jigcar movement request to a MoDel job","properties":{"pin":{"type":"string","description":"the associated MoDel job pin","example":"some-model-pin"}}}}}},"components/schemas/VehicleMovementRequest":{"id":"components/schemas/VehicleMovementRequest","kind":"json-schema","title":"VehicleMovementRequest","data":{"type":"object","required":["id","vehicle","origin","destination","status","businessArea","transportMethod"],"properties":{"id":{"type":"string","format":"ulid","example":"01K4NNVBR6J323BY6X26J62WA5","description":"The identifier for the vehicle movement request"},"vehicle":{"$ref":"#/components/schemas/Vehicle"},"origin":{"allOf":[{"$ref":"#/components/schemas/OriginForCreate"},{"type":"object","properties":{"estimatedCollectionTimeslot":{"description":"The estimated collection timeslot for the vehicle","$ref":"#/components/schemas/Timeslot"},"estimatedCollectionDate":{"description":"The estimated collection date for the vehicle","$ref":"#/components/schemas/Date"}}}]},"destination":{"allOf":[{"$ref":"#/components/schemas/DestinationForCreate"},{"type":"object","properties":{"estimatedDeliveryTimeslot":{"description":"The estimated delivery timeslot for the vehicle","$ref":"#/components/schemas/Timeslot"},"estimatedDeliveryDate":{"description":"The estimated delivery date for the vehicle","$ref":"#/components/schemas/Date"}}}]},"status":{"description":"The status of the movement request","$ref":"#/components/schemas/VehicleMovementRequestStatus"},"completedOn":{"description":"The date that the movement request was completed, if applicable","$ref":"#/components/schemas/DateTime"},"cost":{"description":"The cost of the movement, if known. Populated once the movement has been priced (e.g. by the assigned 3PL).","$ref":"#/components/schemas/Money"},"estimatedCost":{"description":"What the movement is expected to cost, priced against the transport provider's rate card when the movement was created. Absent when the provider has no rate card for the requested transport method.","$ref":"#/components/schemas/Money"},"businessArea":{"$ref":"#/components/schemas/BusinessArea"},"notes":{"type":"string","example":"Talk to Kevin for keys","description":"Any important notes relating to the movement request","maxLength":1024},"externalId":{"type":"string","example":"some-external-identifier","description":"Any external identifier you want to link with this movement request"},"confirmedBy":{"type":"string","description":"The person who confirmed the vehicle is on site and available for collection","example":"John Doe","maxLength":128},"moDelInformation":{"type":"object","description":"Key information for linking a Jigcar movement request to a MoDel job","required":["pin"],"properties":{"pin":{"type":"string","description":"the associated MoDel job pin","example":"some-model-pin"}}},"transportMethod":{"$ref":"#/components/schemas/TransportMethod"},"provider":{"oneOf":[{"$ref":"#/components/schemas/DriverProvider"},{"$ref":"#/components/schemas/ThirdPartyLogisticsProvider"},{"$ref":"#/components/schemas/MarketplaceProvider"}]},"trackingUrl":{"type":"string","format":"uri","example":"https://tracking.jigcar.com?trackingId=3f1c9a7e-2b6d-4d2a-9c1e-8e2b1d5a6f00&vinOrVrm=AB12CDE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public tracking page for this movement. Present once the movement has a tracking record — immediately for movements created into the planning pool, and after the transport provider has accepted otherwise. Omitted when tracking is disabled for your organisation."},"children":[]}]}]}]}}}},"components/schemas/PrepJobStage":{"id":"components/schemas/PrepJobStage","kind":"json-schema","title":"PrepJobStage","data":{"type":"string","example":"APPRAISED","enum":["INBOUND","ARRIVED","APPRAISED","OUTBOUND"]}},"components/schemas/Substage":{"id":"components/schemas/Substage","kind":"json-schema","title":"Substage","data":{"type":"string","example":"SCHEDULED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Substage within the current stage. INBOUND jobs support PENDING_MOVEMENT_REQUEST (vehicle"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchased, destination prep site not chosen yet). OUTBOUND jobs support"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_MOVEMENT_REQUEST, SCHEDULED and DELIVERED."},"children":[]}]}]}],"enum":["PENDING_MOVEMENT_REQUEST","SCHEDULED","DELIVERED"]}},"components/schemas/PrepJobSource":{"id":"components/schemas/PrepJobSource","kind":"json-schema","title":"PrepJobSource","data":{"type":"string","example":"CREATED_MANUALLY","enum":["CREATED_VMR","CREATED_MANUALLY","CREATED_API"]}},"components/schemas/CreateInboundPendingPrepJobBody":{"id":"components/schemas/CreateInboundPendingPrepJobBody","kind":"json-schema","title":"CreateInboundPendingPrepJobBody","data":{"type":"object","required":["vehicle","origin","businessArea"],"properties":{"vehicle":{"type":"object","description":"Details of the purchased vehicle. At least one of vin or vrm must be provided.","properties":{"vin":{"type":"string","maxLength":17,"description":"The Vehicle Identification Number","example":"1C6RR7FT9ES349880"},"vrm":{"type":"string","maxLength":10,"description":"The Vehicle Registration Mark","example":"SX05CWO"},"make":{"type":"string","maxLength":36,"description":"The make of the vehicle","example":"Seat"},"model":{"type":"string","maxLength":128,"description":"The model of the vehicle","example":"Ibiza"},"modelVariant":{"type":"string","maxLength":128,"description":"The extended description of the vehicle","example":"FR Sport"},"colour":{"type":"string","maxLength":100,"description":"The colour of the vehicle","example":"Blue"}}},"origin":{"description":"Where the vehicle is coming from (e.g. the auction site it was purchased at)","oneOf":[{"$ref":"#/components/schemas/InternalLocation"},{"$ref":"#/components/schemas/ExternalLocation"}]},"purchaseDate":{"description":"The date the vehicle was purchased, interpreted in the caller's timezone","$ref":"#/components/schemas/Date"},"businessArea":{"type":"string","maxLength":32,"description":"One of the default business areas (Retail, Fleet) or a custom business area configured for the organisation","example":"Retail"},"notes":{"type":"string","maxLength":1024,"description":"Any notes relating to the prep job"}}}},"components/schemas/PrepJob":{"id":"components/schemas/PrepJob","kind":"json-schema","title":"PrepJob","data":{"type":"object","required":["id","vin","prepSiteId","businessArea","source","stage","createdByUser","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"ulid","example":"01H6SKC5ZDMX0PH7QJJDHJRH7G","description":"The identifier for the prep job"},"vin":{"type":"string","description":"The Vehicle Identification Number","example":"1C6RR7FT9ES349880"},"vrm":{"type":"string","description":"The Vehicle Registration Mark","example":"SX05CWO"},"make":{"type":"string","description":"The make of the vehicle","example":"Seat"},"model":{"type":"string","description":"The model of the vehicle","example":"Ibiza"},"modelVariant":{"type":"string","description":"The extended description of the vehicle","example":"FR Sport"},"prepSiteId":{"type":"string","description":"The identifier for the prep site processing this vehicle","example":"site-prep-01"},"businessArea":{"$ref":"#/components/schemas/BusinessArea"},"source":{"$ref":"#/components/schemas/PrepJobSource"},"stage":{"$ref":"#/components/schemas/PrepJobStage"},"substage":{"$ref":"#/components/schemas/Substage"},"notes":{"type":"string","description":"Any notes relating to the prep job","maxLength":1024},"createdByUser":{"type":"string","description":"Email of the user who created the prep job","example":"user@example.com"},"createdAt":{"$ref":"#/components/schemas/DateTime"},"updatedAt":{"$ref":"#/components/schemas/DateTime"}}}},"schema_9":{"kind":"json-schema","data":{"type":"string","format":"ulid","example":"01K4NNVBR6J323BY6X26J62WA5"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ThirdPartyLogisticsProviderListItem"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","example":"1C6RR7FT9ES349880"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","example":"SX05CWO"},"id":"schema_13"}},"exampleStore":{},"securitySchemeStore":{"JigcarAPIAuth":{"id":"JigcarAPIAuth","type":"apiKey","in":"header","paramName":"X-Jigcar-API-Key"}},"servers":[{"url":"/_mock/openapi-v1","isMockServer":true,"description":"Mock server"},{"url":"https://public-api.jigcar.com/v1"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/openapi-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi-v1.json?download"},{"url":"/_bundle/openapi-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Jigcar Public APIs","description":"Public APIs for interacting with Jigcar"}},"baseSlug":"/openapi-v1","routesMapping":{}}