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

Endpoints

Endpoint	Verb	Paging	Description
/api/location	POST		returns location data for a given to and from address

Post

Returns location data, including satchels available and delivery SLA's (Economy, Priority) for a given to and from address

Objects

Location Request

{
  "conTypeId": 1,
  "from": {
    "streetAddress": "",
    "locality": "",
    "postalCode": "",
    "country": ""
  },
  "to": {
    "streetAddress": "",
    "locality": "",
    "postalCode": "",
    "country": ""
  }
}

ConTypeId - A ConTypeId

Location Response

{
  "data": {
    "locationDetails": {
      "errorMessage": null,
      "locationDetailsKey": "",
      "fromRF": "",
      "toCountryId": 1,
      "toRF": "",
      "toZone": "",
      "zoneUsedForPricing": false,
      "toSubDepot": "",
      "toZoneExcluded": false,
      "satchels": [],
      "slAs": []
    }
  }
}

locationDetailsKey A temporary cache key to be passed into Version 2 of the quote endpoint.