This document outlines how to format a timestamp for communicating with our API.
Timestamps are used in many calls
including requests like
and in many responses.
The timestamp format conforms to ISO 8601 and should look something like this:
If we break this down you can see there are 2 main parts.
The first is the date in
Next is the letter
T which is used to act as a separator between the date and time.
T we have the time using the
v is a number of milliseconds).
Z indicates "zulu time" (a.k.a. GMT),
there are more details below about specifying time zones.
Time zones can be provided in a variety of ways. It is recommended that request always contain a timezone.
If the timezone is provided in GMT, just include the 'Z' at the end:
For any other time zone, include the offset in hh:mm format
shell2018-03-02T14:58:03-05:00 // GMT - 5 Hours
shell2018-03-02T14:58:03+02:00 // GMT + 2 hours
Below are examples in a few different languages for outputting dates in the correct format.
php<?php echo date("c"); // 2019-05-06T13:21:45-04:00 echo date("r", strtotime("2019-05-06T13:21:45-04:00")); // 'Mon, 06 May 2019 13:21:45 -0400'
pythondatetime.datetime.now().replace(tzinfo=datetime.timezone.utc).isoformat() # '2019-05-06T13:26:52.798153+00:00'
bashdate -u +"%Y-%m-%dT%H:%M:%SZ" # 2019-05-06T17:25:17Z
For further reference, timestamps are currently validated against the following regular expression:
Keep in mind that since the timestamp format contains colons it may need to be URL encoded when providing it in a request. For example:
shellcurl -X GET \ "https://api.zentail.com/v1/salesOrder?lastUpdatedTs=2019-05-08T17%3A01%3A16.152Z" \ -H "accept: application/json" \ -H "AUTHORIZATION: <your token here>"