AMCS Group Vehicle API
The Vehicle API from AMCS Group — 3 operation(s) for vehicle.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amcs-group:amcs-group-vehicle-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AMCS Platform REST Vehicle API
description: '
# Overview
## Who Should Read this Document
This document contains a technical description of the AMCS Platform REST API. It is intended for:
· System integrators
· Customer IT team looking to integrate AMCS Platform with another system
· Third parties looking to integrate their system with AMCS Platform
## Document Scope
This document introduces the technical aspects of the AMCS Platform REST API. The purpose of this document is to provide readers with detail on how to:
· Access the REST API
· Make calls to the API to retrieve, append and update resources
· Retrieve the incremental changes to a collection
· Find more detail on the end points that are available from an environment. ## Summary
AMCS Platform REST API is designed to support the integration of AMCS Platform with other systems. With care and additional infrastructure, the REST API can be used to build functionality on top of Platform but that is not it’s primary purpose. The ‘changes since’ process provides the main means of performing an initial synchronisation of the AMCS Platform and another system, and then keeping them synchronised. Methods are also provided to create and update resources. # Integration Patterns and Tools
The AMCS Platform provides a number of tools that can be used to connect systems. Care should be taken to match the right tooling to the intended pattern of integration. · When an extract-based approach is needed, use BI reporting. · When derived values are require, use the data mart. · When business processes on different systems need to be integrated by synchronising the data on each through an event style interface, use the REST API. An integration using the REST API will need to take full responsibility for all aspects of the integration including:
· Pulling change events from AMCS Platform
· Filtering the changed resources for the ones that are of interest
· Pulling additional resources from the REST API in order the retrieve all the properties needed by the destination
· Mashing resources to create the complete view required
· Translating that into the form required by the destination
· Validating this to ensure it meet the entry rules of the destination
· Pushing the result to the destination
In the early stages of designing the interface care should be taken to ensure that the need for caching/staging has been considered. The changes since functionality is effectively a means of pulling create/change events from platform. The only filters available enable retrieval of related resources to build a view external to AMCS Platform
# Basics
The AMCS REST API provides a RESTful interface that allows access to the primary business resources of the AMCS platform. The interface follows general HATEOAS compliance principles. ## Quick start
A quickstart walkthrough based on node.js and covering authentication and getting a page of customers can be found here. ## Interface definitions
Swagger documentation for the end points available on an environment can be found at:
Before 8.5: https://{environment domain name}/swagger/ui/index
From 8.5: https://{environment domain name}/erp/api/swagger/ui/index
## HTTP Interface
The following HTTP RESTful methods are provided as part of this API:
· GET: Provides read access to retrieve details of one or more resources. · POST: Creates or updates a single resource or a set of resources. · PUT: Updates a single resource or a set of resources. Note:
· DELETE methods are currently not provided as part of the API. The REST API URIs begin with
https://{environment domain name}/erp/api/integrator/erp
For example:
https://prod.amcs-at-mycompany.com/erp/api/integrator/erp
This should be used as the base of the URI.'
version: latest
servers:
- url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp
tags:
- name: Vehicle
paths:
/fleet/vehicles/changes:
get:
tags:
- Vehicle
summary: Retrieve changes
description: '| Property | Description |
| ------------------------- | ------------------------------------------------------------------------ |
| GUID| The GUID associated to the vehicle. |
| IsZeroWeightBinAccumulated| Is the zero weight bin accumulated.|
| IsNoTagStopEnabled| Is the no tag stop enabled.|
| RegistrationNo| The registration number associated to the vehicle.|
| VehicleCode | The vehicle code associated to the vehicle.|
| Make | The make associated to the vehicle. |
| Model | The model associated to the vehicle. |
| MaxWeight | The maximum weight associated to the vehicle. |
| TareWeight | The tare weight associated to the vehicle. |
| VolumeCapacity | The volume capacity associated to the vehicle. |
| Notes | The notes associated to the vehicle. |
| RelatedSupplierGuid| The related supplier GUID associated to the vehicle.|
| RelatedSupplierSiteGuid| The related supplier site GUID associated to the vehicle.|
| ContainerTypeListItems[0]| The list of container types associated to the vehicle.|
| ContainerTypeListItems[0].ContainerTypeListItem| The GUID and description of the container type associated to vehicle.|
| CompanyOutletListItem| The GUID and description associated to the company outlet.|
| FilterCompanyOutletListItemGuid| Filter by the company outlet GUID.|
| VehicleTypeListItem| The GUID and description associated to the vehicle type.|
| Trailers[0]| The list of trailers associated to the vehicle.|
| Trailers[0].Guid| The GUID associated to the trailers vehicle.|
| Trailers[0].RelatedTrailerGuid| The related trailer GUID associated to the trailer.|
| RelatedTrailerGuidFilter| Used to filter on the related trailer GUID.|'
operationId: Vehicle_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorVehicleResource'
/fleet/vehicles/{guid}:
get:
tags:
- Vehicle
summary: Find with GUID
description: '| Property | Description |
| ------------------------- | ------------------------------------------------------------------------ |
| GUID| The GUID associated to the vehicle. |
| IsZeroWeightBinAccumulated| Is the zero weight bin accumulated.|
| IsNoTagStopEnabled| Is the no tag stop enabled.|
| RegistrationNo| The registration number associated to the vehicle.|
| VehicleCode | The vehicle code associated to the vehicle.|
| Make | The make associated to the vehicle. |
| Model | The model associated to the vehicle. |
| MaxWeight | The maximum weight associated to the vehicle. |
| TareWeight | The tare weight associated to the vehicle. |
| VolumeCapacity | The volume capacity associated to the vehicle. |
| Notes | The notes associated to the vehicle. |
| RelatedSupplierGuid| The related supplier GUID associated to the vehicle.|
| RelatedSupplierSiteGuid| The related supplier site GUID associated to the vehicle.|
| ContainerTypeListItems[0]| The list of container types associated to the vehicle.|
| ContainerTypeListItems[0].ContainerTypeListItem| The GUID and description of the container type associated to vehicle.|
| CompanyOutletListItem| The GUID and description associated to the company outlet.|
| FilterCompanyOutletListItemGuid| Filter by the company outlet GUID.|
| VehicleTypeListItem| The GUID and description associated to the vehicle type.|
| Trailers[0]| The list of trailers associated to the vehicle.|
| Trailers[0].Guid| The GUID associated to the trailers vehicle.|
| Trailers[0].RelatedTrailerGuid| The related trailer GUID associated to the trailer.|
| RelatedTrailerGuidFilter| Used to filter on the related trailer GUID.|'
operationId: Vehicle_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorVehicleResource'
put:
tags:
- Vehicle
summary: Partial update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the vehicle. | No |
| IsZeroWeightBinAccumulated| Is the zero weight bin accumulated.| Yes |
| IsNoTagStopEnabled| Is the no tag stop enabled.| Yes |
| RegistrationNo| The registration number associated to the vehicle.| Yes |
| VehicleCode | The vehicle code associated to the vehicle.| Yes |
| Make | The make associated to the vehicle. | Yes |
| Model | The model associated to the vehicle. | Yes |
| MaxWeight | The maximum weight associated to the vehicle. | No |
| TareWeight | The tare weight associated to the vehicle. | No |
| VolumeCapacity | The volume capacity associated to the vehicle. | No |
| Notes | The notes associated to the vehicle. | No |
| RelatedSupplierGuid| The related supplier GUID associated to the vehicle.| No |
| RelatedSupplierSiteGuid| The related supplier site GUID associated to the vehicle.| No |
| ContainerTypeListItems[0]| The list of container types associated to the vehicle.| No |
| ContainerTypeListItems[0].ContainerTypeListItem| The GUID and description of the container type associated to vehicle.| No |
| CompanyOutletListItem| The GUID and description associated to the company outlet.| No |
| FilterCompanyOutletListItemGuid| Filter by the company outlet GUID.| No |
| VehicleTypeListItem| The GUID and description associated to the vehicle type.| No |
| Trailers[0]| The list of trailers associated to the vehicle.| No |
| Trailers[0].Guid| The GUID associated to the trailers vehicle.| No |
| Trailers[0].RelatedTrailerGuid| The related trailer GUID associated to the trailer.| No |
| RelatedTrailerGuidFilter| Used to filter on the related trailer GUID.| No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If RelatedSupplierGuid has a value but RelatedSupplierSiteGuid is null | The mandatory property RelatedSupplierSiteGuid has a null value. The request could not be processed. Supply a value for the RelatedSupplierSiteGuid property of the submitted resource. |
| CompanyOutletListItem.Guid is duplicate | The Guid must be unique per ContainerTypeListItem |
| If Make is more than 30 characters long | Make must be no more than 30 characters long. |
| If Model is more than 30 characters long | Model must be no more than 30 characters long. |
| If RegistrationNo is more than 30 characters long | RegistrationNo must be no more than 30 characters long. |
| If VehicleCode is more than 60 characters long | VehicleCode must be no more than 60 characters long. |
| If MaxWeight value is more than 10 characters long | MaxWeight must be no more than 10 characters long. |
| If TareWeight value is more than 10 characters long | TareWeight must be no more than 10 characters long. |
| If VolumeCapacity value is more than 10 characters long | VolumeCapacity must be no more than 10 characters long. |
| If VolumeCapacity has negative value | VolumeCapacity must be a positive number. |
| Both RegistrationNo and VehicleCode values already exist | The Vehicle that you are trying to save conflicts with an existing item. Each Vehicle must be unique in terms of Registration Number and Vehicle Code |
| RegistrationNo value already exists | The Vehicle that you are trying to save conflicts with an existing item. Each Vehicle must be unique in terms of Registration Number |
| VehicleCode value already exists | The Vehicle that you are trying to save conflicts with an existing item. Each Vehicle must be unique in terms of Vehicle Code |
| If RelatedTrailerGuid is deleted | Failed to save. IsDeleted flag set to true for RelatedTrailerGuid property with GUID XXXXXXXX-XXXXX-XXXX-XXXX-XXXXXXXXXXXX |
| If RelatedTrailerGuid has IsExternal flag to true | Failed to save/update Vehicle because the given Trailers.Guid has the IsExternal to true, provide the Trailers.Guid that has IsExternal to false. |'
operationId: Vehicle_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorVehicleResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/fleet/vehicles:
get:
tags:
- Vehicle
summary: Find with Filters
description: '| Property | Description |
| ------------------------- | ------------------------------------------------------------------------ |
| GUID| The GUID associated to the vehicle. |
| IsZeroWeightBinAccumulated| Is the zero weight bin accumulated.|
| IsNoTagStopEnabled| Is the no tag stop enabled.|
| RegistrationNo| The registration number associated to the vehicle.|
| VehicleCode | The vehicle code associated to the vehicle.|
| Make | The make associated to the vehicle. |
| Model | The model associated to the vehicle. |
| MaxWeight | The maximum weight associated to the vehicle. |
| TareWeight | The tare weight associated to the vehicle. |
| VolumeCapacity | The volume capacity associated to the vehicle. |
| Notes | The notes associated to the vehicle. |
| RelatedSupplierGuid| The related supplier GUID associated to the vehicle.|
| RelatedSupplierSiteGuid| The related supplier site GUID associated to the vehicle.|
| ContainerTypeListItems[0]| The list of container types associated to the vehicle.|
| ContainerTypeListItems[0].ContainerTypeListItem| The GUID and description of the container type associated to vehicle.|
| CompanyOutletListItem| The GUID and description associated to the company outlet.|
| FilterCompanyOutletListItemGuid| Filter by the company outlet GUID.|
| VehicleTypeListItem| The GUID and description associated to the vehicle type.|
| Trailers[0]| The list of trailers associated to the vehicle.|
| Trailers[0].Guid| The GUID associated to the trailers vehicle.|
| Trailers[0].RelatedTrailerGuid| The related trailer GUID associated to the trailer.|
| RelatedTrailerGuidFilter| Used to filter on the related trailer GUID.|'
operationId: Vehicle_GetCollection
parameters:
- name: filter
in: query
schema:
type: string
- name: max
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: includeCount
in: query
schema:
type: boolean
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection_ApiIntegratorVehicleResource'
post:
tags:
- Vehicle
summary: Create or update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the vehicle. | No |
| IsZeroWeightBinAccumulated| Is the zero weight bin accumulated.| Yes |
| IsNoTagStopEnabled| Is the no tag stop enabled.| Yes |
| RegistrationNo| The registration number associated to the vehicle.| Yes |
| VehicleCode | The vehicle code associated to the vehicle.| Yes |
| Make | The make associated to the vehicle. | Yes |
| Model | The model associated to the vehicle. | Yes |
| MaxWeight | The maximum weight associated to the vehicle. | No |
| TareWeight | The tare weight associated to the vehicle. | No |
| VolumeCapacity | The volume capacity associated to the vehicle. | No |
| Notes | The notes associated to the vehicle. | No |
| RelatedSupplierGuid| The related supplier GUID associated to the vehicle.| No |
| RelatedSupplierSiteGuid| The related supplier site GUID associated to the vehicle.| No |
| ContainerTypeListItems[0]| The list of container types associated to the vehicle.| No |
| ContainerTypeListItems[0].ContainerTypeListItem| The GUID and description of the container type associated to vehicle.| No |
| CompanyOutletListItem| The GUID and description associated to the company outlet.| No |
| FilterCompanyOutletListItemGuid| Filter by the company outlet GUID.| No |
| VehicleTypeListItem| The GUID and description associated to the vehicle type.| No |
| Trailers[0]| The list of trailers associated to the vehicle.| No |
| Trailers[0].Guid| The GUID associated to the trailers vehicle.| No |
| Trailers[0].RelatedTrailerGuid| The related trailer GUID associated to the trailer.| No |
| RelatedTrailerGuidFilter| Used to filter on the related trailer GUID.| No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If RelatedSupplierGuid has a value but RelatedSupplierSiteGuid is null | The mandatory property RelatedSupplierSiteGuid has a null value. The request could not be processed. Supply a value for the RelatedSupplierSiteGuid property of the submitted resource. |
| CompanyOutletListItem.Guid is duplicate | The Guid must be unique per ContainerTypeListItem |
| If Make is more than 30 characters long | Make must be no more than 30 characters long. |
| If Model is more than 30 characters long | Model must be no more than 30 characters long. |
| If RegistrationNo is more than 30 characters long | RegistrationNo must be no more than 30 characters long. |
| If VehicleCode is more than 60 characters long | VehicleCode must be no more than 60 characters long. |
| If MaxWeight value is more than 10 characters long | MaxWeight must be no more than 10 characters long. |
| If TareWeight value is more than 10 characters long | TareWeight must be no more than 10 characters long. |
| If VolumeCapacity value is more than 10 characters long | VolumeCapacity must be no more than 10 characters long. |
| If VolumeCapacity has negative value | VolumeCapacity must be a positive number. |
| Both RegistrationNo and VehicleCode values already exist | The Vehicle that you are trying to save conflicts with an existing item. Each Vehicle must be unique in terms of Registration Number and Vehicle Code |
| RegistrationNo value already exists | The Vehicle that you are trying to save conflicts with an existing item. Each Vehicle must be unique in terms of Registration Number |
| VehicleCode value already exists | The Vehicle that you are trying to save conflicts with an existing item. Each Vehicle must be unique in terms of Vehicle Code |
| If RelatedTrailerGuid is deleted | Failed to save. IsDeleted flag set to true for RelatedTrailerGuid property with GUID XXXXXXXX-XXXXX-XXXX-XXXX-XXXXXXXXXXXX |
| If RelatedTrailerGuid has IsExternal flag to true | Failed to save/update Vehicle because the given Trailers.Guid has the IsExternal to true, provide the Trailers.Guid that has IsExternal to false. |'
operationId: Vehicle_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorVehicleResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiIntegratorVehicleResource:
type: object
properties:
IsZeroWeightBinAccumulated:
type: boolean
IsNoTagStopEnabled:
type: boolean
RegistrationNo:
type: string
VehicleCode:
type: string
Make:
type: string
Model:
type: string
MaxWeight:
type: number
format: double
TareWeight:
type: number
format: double
VolumeCapacity:
type: number
format: double
Notes:
type: string
CompanyOutletListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
FilterCompanyOutletListItemGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ContainerTypeListItems:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorVehicleContainerTypeResource'
VehicleTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
RelatedSupplierGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedSupplierSiteGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
Trailers:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorVehicleTrailerResource'
RelatedTrailerGuidFilter:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiIntegratorVehicleTrailerResource:
type: object
properties:
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedTrailerGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiIntegratorVehicleContainerTypeResource:
type: object
properties:
ContainerTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApiResourceResultEntity_ApiIntegratorVehicleResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorVehicleResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties:
type: object
ApiResourceResultEntityLinks:
type: object
properties:
self:
type: string
associations:
type: array
items:
type: string
expand:
type: array
items:
type: string
operations:
type: array
items:
type: string
ApiResourceResultCollection_ApiIntegratorVehicleResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorVehicleResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceChanges_ApiIntegratorVehicleResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorVehicleResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceErrors:
type: object
properties:
errors:
type: string