HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog
Terms of Use

Release Notes: Public API 2.117.0

  1. Introduce Locations v2.0 resource
    1. Properties:
      • id - readonly
        integer
      • name - required
        string
      • status - required
        enum
      • shortDescription - optional, translatable
        array or NULL
      • description - optional, translatable
        array or NULL
      • additionalDescription - optional, translatable
        array or NULL
      • locationImage - optional, readonly
      • images - optional, readonly
      • geoposition - required
        • latitude - required
          float
        • longitude - required
          float
      • address - required
        translatable
      • city - required
        string
      • region - optional
        string
      • state - optional, conditional depending on country = US or AU
        string or NULL
      • country - required
        string
      • postCode - required
        string
      • workingHours - required
        array
        • isAlwaysOpen - required
          boolean
        • alwaysOpenForUserGroupIds - optional
          array of group ids
          required if isAlwaysOpen = false; otherwise NULL
        • stopSessionsOutsideWorkingHours - optional
          boolean
          required if isAlwaysOpen = false
        • hours - optional
      • chargingZones - required, readonly
        array
      • timezone - optional (only when multi timezone is enabled)
        string
      • externalId - optional
        string
      • lastUpdatedAt - required
        timestamp
  2. Expose Charging Zones endpoint in the API
    Supported Methods: GET, POST, PATCH, DELETE
    • Properties:
      • id
        integer
      • name - required
        string
        Description: Internal name of the Charging Zone. This isn't visible to end-users in the app.
        locationId - required
        integer
        Description: The ID of the Location, which the Charging Zone belongs to.
      • status - required
        string
        Description: Enum: "active" "disabled"
      • appAdditionalInfo - optional
        object
        Description: Additional information for the charging zone that is shown in the mobile app when the Location is viewed.
      • title - required
        object
        Description: Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.
      • description - required
        object
        Description: Locales that have been created and are not provided on an update will be deleted. Please provide values in all locales that you wish to keep.
    • Filter
      • locationId