AMCS Group

AMCS Group VehicleCarrierWork API

The VehicleCarrierWork API from AMCS Group — 1 operation(s) for vehiclecarrierwork.

Documentation GitHub OpenAPI

Operations 1

GET /integrator/vehicleCarrierWorks Find with Filters #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amcs-group/openapi/amcs-group-vehiclecarrierwork-api-openapi.yml

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amcs-group:amcs-group-vehiclecarrierwork-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: '# Getting Started


    ## Document Purpose and Scope


    The Scale REST API endpoints are technically described in this document. This document''s goal is to instruct readers on how to interface with the Scale REST API.


    ## Security


    The API uses HTTPS as transport layer for security and uses HTTP/1.1 – RFC 7230 for message syntax and routing.


    There are 2 ways of authenticating in order to access the REST API.


    · Requesting a bearer token from /authTokens using username and password


    · Requesting a session log on from /authTokens using a PAT token


    Authentication using username and password will be phased out after 8.6.


    ## GET /authTokens with username and password direct to the App server


    Before using this method a user must be set up with access right “Can POST, PUT, GET to the REST API”. This can be done from User Management in the Scale UI.


    ### Request format


    The following table specifies the format and parameters for this request.


    | Method | Type | Name | Type |

    | --------- | --------- | ------------------ | ------------------ |

    | GET | Parameter | Username | URI encoded string |

    | Parameter | password | URI encoded string | |


    ### Response format


    The following table specifies the format and parameters for the response.


    | Successful response | Type | |

    | ------------------- | --------- | ---- |

    | Bearer token | text/html | |


    The token returned is then uses as a Bearer token in the subsequent calls to the REST API


    ### Example


    The following shows an example of a request to the authentication endpoint:


    https://{scale-url}/scale/api/authTokens?username=john&password=password


    The username and password in this request may need to be URI encoded.


    The token in the response should be supplied in all subsequent requests in an authorization HTTP header.


    Authorization: Bearer tcpRoNbIKOJZj9Yn0CL2oiX7m04JJmlAllaskd810incqjslasadjzxzza29axb


    Notes:


    · No specific Accept or Content-Type header is required for the authentication endpoint as it will always return text/html as content.


    ## POST /scale/api/authTokens with PAT token


    Before using this method, a user must be set up with:


    · Access right “Can POST, PUT, GET to the REST API”


    · A PAT token


    This can be done from User Management in the Scale UI.


    ### Request format


    The following table specifies the format and parameters for this request.


    | Method | Body |

    | ------ | ------------------------------ |

    | POST | { “privatekey”:”{PAT token}” } |


    ### Response format


    The response passes a Platform.ERP.SessionToken as a cookie.


    This cookie should be included in the subsequent calls to the REST API."'
  title: Scale REST Vehicle Carrier Work API
  version: '9.1'
servers:
- url: http://{env}-svc-core.amcsplatform.com/scale/api/
tags:
- name: VehicleCarrierWork
paths:
  /integrator/vehicleCarrierWorks:
    get:
      tags:
      - VehicleCarrierWork
      summary: Find with Filters
      description: '| Property | Description |

        | --------------------------------------------------------------| ----------------------------------------------------------------------------------|

        | SubscriberGUID | The subscriber guid filterable and required. |

        | VehicleGUID | The vechicle guid filterable and required. |

        | CarrierGUID | The suppliersite guid filterable and optional. |

        | StageWeighing[] | The weighing data is on stage status. |

        | StageWeighing[].WeighingGUID | The guid associated to the weighing. |

        | StageWeighing[].TicketNo | The ticketno associated to the weighing. |

        | StageWeighing[].GrossWeight | The grossweight associated to the weighing. |

        | StageWeighing[].TareWeight | The tareweight associated to the weighing. |

        | StageWeighing[].IsInboundWeighing | The isinboundweighing indicator of weighing base on weighing type |

        | CurrentLinkedJobs[] | The current linked jobs does not associated any weighning. |

        | CurrentLinkedJobs[].JobGUID | The job guid. |

        | CurrentLinkedJobs[].TicketNo | The ticketno weighing associated to the job. |

        | CurrentLinkedJobs[].DefaultMaterial | The defaultmaterial material assocaited to the job. |

        | CurrentLinkedJobs[].MaterialShortCode | The materialshortcode material assocaited to the job. |

        | CurrentLinkedJobs[].MaterialAnalysisCode | The materialanalysiscode material assocaited to the job. |

        | CurrentLinkedJobs[].MaterialEWCCode | The materialewccode material assocaited to the job. |

        | CurrentLinkedRoutes[] | The current linked routes that are not completed. |

        | CurrentLinkedRoutes[].RouteGUID | The route guid. |

        | CurrentLinkedRoutes[].RouteNo | The route number. |

        | CurrentLinkedRoutes[].DefaultMaterial | The default material associated to the route. |

        | CurrentLinkedRoutes[].MaterialShortCode | The material short code. |

        | CurrentLinkedRoutes[].MaterialEWCCode | The material ew code. |

        | CurrentLinkedRoutes[].LinkedMaterials[] | The materials that are linked to the route. |

        | CurrentLinkedRoutes[].LinkedMaterials[].MaterialGUID | The linked material guid. |

        | CurrentLinkedRoutes[].LinkedMaterials[].Material | The linked material description. |

        | CurrentLinkedRoutes[].LinkedMaterials[].MaterialShortCode | The linked material short code. |

        | CurrentLinkedRoutes[].LinkedMaterials[].MaterialAnalysisCode | The linked material analysis code. |

        | CurrentLinkedRoutes[].LinkedMaterials[].MaterialEWCCode | The linked material ew code. |

        | LinkedToMoreThanOneCustomers | The flag that tells a vehicle is linked one or more customers. | |

        | CurrentLinkedCustomers[].CustomerGUID | The customer guid. |

        | CurrentLinkedCustomers[].CustomerSiteGUID | The customersite guid. |

        | CurrentLinkedCustomers[].Customer | The customer name. |

        | CurrentLinkedCustomers[].LinkedToMoreThanOneOrder | The flag that tells whether a customer has one or more orders. | |

        | CurrentLinkedCustomers[].LinkedOrders[].OrderNo | The order number. |

        | CurrentLinkedCustomers[].LinkedOrders[].OrderGUID | The order guid. |

        | CurrentLinkedCustomers[].LinkedOrders[].AreaOfOrigin | The area of origin description. |

        | CurrentLinkedCustomers[].LinkedOrders[].ShortCode | The area of origin short code. |'
      operationId: VehicleCarrierWork_GetCollection
      parameters:
      - name: filter
        in: query
        required: false
        schema:
          type: string
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: order
        in: query
        required: false
        schema:
          type: string
      - name: max
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: includeCount
        in: query
        required: false
        schema:
          type: boolean
      - name: includeDeleted
        in: query
        required: false
        schema:
          type: boolean
      - name: links
        in: query
        required: false
        schema:
          type: string
      - name: udf
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection_ApiVehicleCarrierWorkResource'
components:
  schemas:
    ApiVehicleCarrierWorkCurrentLinkedCustomersResource:
      type: object
      properties:
        CustomerGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        CustomerSiteGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        Customer:
          type: string
        CustomerSite:
          type: string
        LinkedToMoreThanOneOrder:
          type: boolean
        LinkedOrders:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkLinkedToCustomerLinkedOrdersResource'
        GUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        LastChangeReasonId:
          format: int32
          type: integer
    ApiVehicleCarrierWorkCurrentLinkedJobsResource:
      type: object
      properties:
        JobGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        TicketNo:
          type: string
        DefaultMaterial:
          type: string
        MaterialShortCode:
          type: string
        MaterialAnalysisCode:
          type: string
        MaterialEWCCode:
          type: string
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          format: int32
          type: integer
    ApiResourceResultCollection_ApiVehicleCarrierWorkResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiVehicleCarrierWorkStageWeighingResource:
      type: object
      properties:
        WeighingGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        TicketNo:
          type: string
        WeighingDate:
          format: dateTime
          type: string
          example: '2000-01-01 00:00:00.000'
        IsInboundWeighing:
          type: boolean
        GrossWeight:
          format: double
          type: number
        TareWeight:
          format: double
          type: number
    ApiVehicleCarrierWorkLinkedToCustomerLinkedOrdersResource:
      type: object
      properties:
        OrderNo:
          type: string
        OrderGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        AreaOfOriginGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        AreaOfOrigin:
          type: string
        ShortCode:
          type: string
        InboundOrder:
          type: boolean
        LinkedMaterials:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkLinkedToCustomerLinkedOrderMaterialsResource'
        GUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        LastChangeReasonId:
          format: int32
          type: integer
    ApiVehicleCarrierWorkCurrentLinkedRoutesResource:
      type: object
      properties:
        RouteGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        RouteNo:
          format: int32
          type: integer
        DefaultMaterial:
          type: string
        MaterialShortCode:
          type: string
        MaterialEWCCode:
          type: string
        LinkedMaterials:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkCurrentLinkedMaterialsResource'
        GUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        LastChangeReasonId:
          format: int32
          type: integer
    ApiResourceStatus:
      type: object
      properties:
        id:
          format: int32
          type: integer
        isSuccess:
          type: boolean
    ApiVehicleCarrierWorkResource:
      type: object
      properties:
        VehicleGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        CarrierGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        SubscriberGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        StageWeighing:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkStageWeighingResource'
        CurrentLinkedRoutes:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkCurrentLinkedRoutesResource'
        CurrentLinkedJobs:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkCurrentLinkedJobsResource'
        LinkedToMoreThanOneCustomers:
          type: boolean
        CurrentLinkedCustomers:
          type: array
          items:
            $ref: '#/components/schemas/ApiVehicleCarrierWorkCurrentLinkedCustomersResource'
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
    ApiVehicleCarrierWorkLinkedToCustomerLinkedOrderMaterialsResource:
      type: object
      properties:
        MaterialGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        Material:
          type: string
        ShortCode:
          type: string
        MaterialAnalysisCode:
          type: string
        MaterialEWCCode:
          type: string
        GUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        LastChangeReasonId:
          format: int32
          type: integer
    ApiVehicleCarrierWorkCurrentLinkedMaterialsResource:
      type: object
      properties:
        MaterialGUID:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        Material:
          type: string
        MaterialShortCode:
          type: string
        MaterialAnalysisCode:
          type: string
        MaterialEWCCode:
          type: string