Address

Add or update address

Changed on
post/Address

Request

  • Base URL
    https://api.track-pod.com (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-KEY

Request body

Idstring nullable

Unique identifier in user accounting system

Namestring nullable

Address name

Streetstring nullable

Street

Citystring nullable

City

Statestring nullable

State

PostalCodestring nullable

Postal Code

FullAddressstring required

Full (customer's) address

Zonestring nullable

Address zone

Latnumber double nullable

Location latitude

Lonnumber double nullable

Location longitude

TimeSlotFromstring date-time nullable

Desired delivery/pickup time from, yyyy-MM-ddTHH:mm:ss or HH:mm:ss

TimeSlotTostring date-time nullable

Desired delivery/pickup time till, yyyy-MM-ddTHH:mm:ss or HH:mm:ss

Example request

{
  "Id": "30495",
  "Name": "2 St Josephs Crescent, Liverpool, L3 3JF",
  "Street": "Josephs Crescent",
  "City": "Liverpool",
  "FullAddress": "2 St Josephs Crescent, Liverpool, L3 3JF",
  "Zone": "Lvp",
  "Lat": 25.290479,
  "Lon": 65.294049,
  "TimeSlotFrom": "2019-02-01T09:00:00",
  "TimeSlotTo": "2019-02-01T18:00:00"
}

Response

Address was created successfully

Statusinteger nullable

The HTTP status code for the response

Titlestring nullable

A short, human-readable summary of the response

Detailstring nullable

A human-readable explanation specific to this response.

Changes

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/xml)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/xml)

    • info

      added optional request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/xml for the response with the status

    • info

      added the media type text/json for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/xml for the response with the status