Endpoints꞉ Consignment Services - Fastway-Couriers-South-Africa/myFastway.ApiClient GitHub Wiki

********************************************************************

Note: This is future functionality, endpoints and response objects a subject to change

********************************************************************

Endpoints

Endpoint	Verb	Paging	Description
/api/consignment-services	GET	Y	returns all available consignment services

Response Objects

Service

{
  "ServiceId": 0,
  "Code": "",
  "Name": "",
  "Description": "",
  "ChargeLevel": "",
  "Items": [
    {
      "ServiceItemId": 0,
      "Code": "",
      "Description": "",
      "Price": 0
    }
  ]
}

Service Object Properties

Charge level

The charge level of a service can either be (C)onsignment or (I)tem level.

Consignment level services are mandatory by nature and applied automatically to the consignment, typical consignment level services may be Fuel or on-forwarding surcharges

Items (array)

An array of items may be returned for a given service. Each Item will have a price / cost associated with it. An example of a collection that may be returned are Delivery options e.g:

• ATL - Authority to Leave
• SIG - Signature Required