Structure "Collection location"

This structure describes a collection or delivery location of goods. It is included in the "Freight" structure and "Vehicles" structure as arrays under the names waypointListSource and waypointListTarget.

Field description

Name	Description	Data type	Required
town	Town from the directory.	Object	+
town.id	Town id. May be 0 if the city is specified arbitrarily.	Number
town.name	Localized town name. May contain an arbitrary town name in any language, if the town is not taken from the directory.	String	+
area	Region from the directory.	Object
area.id	Region id.	Number	+
area.name	Localized region name.	String	+
region	Country part from the directory.	Object
region.id	Country part id.	Number	+
region.name	Localized name of a country part.	String	+
country	Country	"Country" structure.	+
address	Arbitrary address	String
lat	Latitude	Number
lon	Longitude	Number
postalCodes	Town postcodes.	Array of strings
postalZones	Town postal zones.	Array of strings

Samples

JSON

• Sample with a region:

  {
      "town": {
          "id": 69,
          "name": "Харьков"
      },
      "area": {
          "id": 34,
          "name": "Харьковская обл."
      },
      "country": {
          "sign": "UA",
          "name": "Украина"
      },
      "postCode": "61",
      "address": "Где-то в центре",
      "lat": 49.9935,
      "lon": 36.230383
  }
  

• Sample with a country part:

  {
      "town": {
          "id": 0,
          "name": ""
      },
      "region": {
          "id": 4,
          "name": "Запад"
      },
      "country": {
          "sign": "UA",
          "name": "Украина"
      },
      "postCode": "",
      "address": "",
      "lat": 0,
      "lon": 0
  }