Class Date

A Date object contains a number indicating a particular instant in time to within a millisecond. The number may also be NaN, indicating that the Date object does not represent a specific instant of time.

Constructor Summary 
ConstructorDescription
Date()Constructs the Date instance using the current date and time.
Date(Number)Constructs the Date instance using the specified milliseconds.
Date(Number, Number, Number…)Constructs the Date instance using the specified year and month.
Date(String)Constructs the Date instance by parsing the specified String.

Method Summary 
MethodDescription
static UTC(Number, Number, Number…)Returns the number of milliseconds since midnight of January 1, 1970 according to universal time.
getDate()Returns the day of the month where the value is a Number from 1 to 31.
getDay()Returns the day of the week where the value is a Number from 0 to 6.
getFullYear()Returns the year of the Date in four-digit format.
getHours()Return the hours field of the Date where the value is a Number from 0 (midnight) to 23 (11 PM).
getMilliseconds()Returns the milliseconds field of the Date.
getMinutes()Return the minutes field of the Date where the value is a Number from 0 to 59.
getMonth()Returns the month of the year as a value between 0 and 11.
getSeconds()Return the seconds field of the Date where the value is a Number from 0 to 59.
getTime()Returns the internal, millisecond representation of the Date object.
getTimezoneOffset()Returns the difference between local time and Greenwich Mean Time (GMT) in minutes.
getUTCDate()Returns the day of the month where the value is a Number from 1 to 31 when date is expressed in universal time.
getUTCDay()Returns the day of the week where the value is a Number from 0 to 6 when date is expressed in universal time.
getUTCFullYear()Returns the year when the Date is expressed in universal time.
getUTCHours()Return the hours field, expressed in universal time, of the Date where the value is a Number from 0 (midnight) to 23 (11 PM).
getUTCMilliseconds()Returns the milliseconds field, expressed in universal time, of the Date.
getUTCMinutes()Return the minutes field, expressed in universal time, of the Date where the value is a Number from 0 to 59.
getUTCMonth()Returns the month of the year that results when the Date is expressed in universal time.
getUTCSeconds()Return the seconds field, expressed in universal time, of the Date where the value is a Number from 0 to 59.
static now()Returns the number of milliseconds since midnight of January 1, 1970 up until now.
static parse(String)Takes a date string and returns the number of milliseconds since midnight of January 1, 1970.
setDate(Number)Sets the day of the month where the value is a Number from 1 to 31.
setFullYear(Number, Number…)Sets the full year of Date where the value must be a four-digit Number.
setHours(Number, Number…)Sets the hours field of this Date instance.
setMilliseconds(Number)Sets the milliseconds field of this Date instance.
setMinutes(Number, Number…)Sets the minutes field of this Date instance.
setMonth(Number, Number…)Sets the month of the year where the value is a Number from 0 to 11.
setSeconds(Number, Number…)Sets the seconds field of this Date instance.
setTime(Number)Sets the number of milliseconds between the desired date and time and January 1, 1970.
setUTCDate(Number)Sets the day of the month, expressed in universal time, where the value is a Number from 1 to 31.
setUTCFullYear(Number, Number…)Sets the full year, expressed in universal time, of Date where the value must be a four-digit Number.
setUTCHours(Number, Number…)Sets the hours field, expressed in universal time, of this Date instance.
setUTCMilliseconds(Number)Sets the milliseconds field, expressed in universal time, of this Date instance.
setUTCMinutes(Number, Number…)Sets the minutes field, expressed in universal time, of this Date instance.
setUTCMonth(Number, Number…)Sets the month of the year, expressed in universal time, where the value is a Number from 0 to 11.
setUTCSeconds(Number, Number…)Sets the seconds field, expressed in universal time, of this Date instance.
toDateString()Returns the Date as a String value where the value represents the date portion of the Date in the default locale (en_US).
toISOString()This function returns a string value represent the instance in time represented by this Date object.
toJSON(String)This function returns the same string as Date.prototype.toISOString().
toLocaleDateString()Returns the Date as a String value where the value represents the date portion of the Date in the default locale (en_US).
toLocaleString()Returns the Date as a String using the default locale (en_US).
toLocaleTimeString()Returns the Date as a String value where the value represents the time portion of the Date in the default locale (en_US).
toTimeString()Returns the Date as a String value where the value represents the time portion of the Date in the default locale (en_US).
toUTCString()Returns a String representation of this Date, expressed in universal time.
valueOf()Returns the value of this Date represented in milliseconds.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Details 

Date() 
Date()

Constructs the Date instance using the current date and time.

Date(Number) 
Date(millis: Number)

Constructs the Date instance using the specified milliseconds.

Parameters:

  • millis - the number of milliseconds between the desired date and January 1, 1970 (UTC). For example, value of 10000 would create a Date instance representing 10 seconds past midnight on January 1, 1970.

Date(Number, Number, Number...) 
Date(year: Number, month: Number, args: Number...)

Constructs the Date instance using the specified year and month. Optionally, you can pass up to five additional arguments representing date, hours, minutes, seconds, and milliseconds.

Parameters:

  • year - a number representing the year.
  • month - a number representing the month.
  • args - a set of numbers representing the date, hours, minutes, seconds, and milliseconds.

Date(String) 
Date(dateString: String)

Constructs the Date instance by parsing the specified String.

Parameters:

  • dateString - represents a Date in a valid date format.

Method Details 

UTC(Number, Number, Number...) 
static UTC(year: Number, month: Number, args: Number...): Number

Returns the number of milliseconds since midnight of January 1, 1970 according to universal time. Optionally, you can pass up to five additional arguments representing date, hours, minutes, seconds, and milliseconds.

Parameters:

  • year - a number representing the year.
  • month - a number representing the month.
  • args - a set of numbers representing the date, hours, minutes, seconds, and milliseconds.

Returns:

  • the number of milliseconds since midnight of January 1, 1970 according to universal time.

getDate() 
getDate(): Number

Returns the day of the month where the value is a Number from 1 to 31.

Returns:

  • the day of the month where the value is a Number from 1 to 31.

getDay() 
getDay(): Number

Returns the day of the week where the value is a Number from 0 to 6.

Returns:

  • the day of the month where the value is a Number from 0 to 6.

getFullYear() 
getFullYear(): Number

Returns the year of the Date in four-digit format.

Returns:

  • the year of the Date in four-digit format.

getHours() 
getHours(): Number

Return the hours field of the Date where the value is a Number from 0 (midnight) to 23 (11 PM).

Returns:

  • the hours field of the Date where the value is a Number from 0 (midnight) to 23 (11 PM).

getMilliseconds() 
getMilliseconds(): Number

Returns the milliseconds field of the Date.

Returns:

  • the milliseconds field of the Date.

getMinutes() 
getMinutes(): Number

Return the minutes field of the Date where the value is a Number from 0 to 59.

Returns:

  • the minutes field of the Date where the value is a Number from 0 to 59.

getMonth() 
getMonth(): Number

Returns the month of the year as a value between 0 and 11.

Returns:

  • the month of the year as a value between 0 and 11.

getSeconds() 
getSeconds(): Number

Return the seconds field of the Date where the value is a Number from 0 to 59.

Returns:

  • the seconds field of the Date where the value is a Number from 0 to 59.

getTime() 
getTime(): Number

Returns the internal, millisecond representation of the Date object. This value is independent of time zone.

Returns:

  • the internal, millisecond representation of the Date object.

getTimezoneOffset() 
getTimezoneOffset(): Number

Returns the difference between local time and Greenwich Mean Time (GMT) in minutes.

Returns:

  • the difference between local time and Greenwich Mean Time (GMT) in minutes.

getUTCDate() 
getUTCDate(): Number

Returns the day of the month where the value is a Number from 1 to 31 when date is expressed in universal time.

Returns:

  • the day of the month where the value is a Number from 1 to 31 when date is expressed in universal time.

getUTCDay() 
getUTCDay(): Number

Returns the day of the week where the value is a Number from 0 to 6 when date is expressed in universal time.

Returns:

  • the day of the week where the value is a Number from 0 to 6 when date is expressed in universal time.

getUTCFullYear() 
getUTCFullYear(): Number

Returns the year when the Date is expressed in universal time. The return value is a four-digit format.

Returns:

  • the year of the Date in four-digit form.

getUTCHours() 
getUTCHours(): Number

Return the hours field, expressed in universal time, of the Date where the value is a Number from 0 (midnight) to 23 (11 PM).

Returns:

  • the hours field, expressed in universal time, of the Date where the value is a Number from 0 (midnight) to 23 (11 PM).

getUTCMilliseconds() 
getUTCMilliseconds(): Number

Returns the milliseconds field, expressed in universal time, of the Date.

Returns:

  • the milliseconds field, expressed in universal time, of the Date.

getUTCMinutes() 
getUTCMinutes(): Number

Return the minutes field, expressed in universal time, of the Date where the value is a Number from 0 to 59.

Returns:

  • the minutes field, expressed in universal time, of the Date where the value is a Number from 0 to 59.

getUTCMonth() 
getUTCMonth(): Number

Returns the month of the year that results when the Date is expressed in universal time. The return value is a Number betwee 0 and 11.

Returns:

  • the month of the year as a value between 0 and 11.

getUTCSeconds() 
getUTCSeconds(): Number

Return the seconds field, expressed in universal time, of the Date where the value is a Number from 0 to 59.

Returns:

  • the seconds field, expressed in universal time, of the Date where the value is a Number from 0 to 59.

now() 
static now(): Number

Returns the number of milliseconds since midnight of January 1, 1970 up until now.

Returns:

  • the number of milliseconds since midnight of January 1, 1970.

parse(String) 
static parse(dateString: String): Number

Takes a date string and returns the number of milliseconds since midnight of January 1, 1970.

Supports:

  • RFC2822 date strings
  • strings matching the exact ISO 8601 format 'YYYY-MM-DDTHH:mm:ss.sssZ'

Parameters:

  • dateString - represents a Date in a valid date format.

Returns:

  • the number of milliseconds since midnight of January 1, 1970 or NaN if no date could be recognized.

setDate(Number) 
setDate(date: Number): Number

Sets the day of the month where the value is a Number from 1 to 31.

Parameters:

  • date - the day of the month.

Returns:

  • the millisecond representation of the adjusted date.

setFullYear(Number, Number...) 
setFullYear(year: Number, args: Number...): Number

Sets the full year of Date where the value must be a four-digit Number. Optionally, you can set the month and date.

Parameters:

  • year - the year as a four-digit Number.
  • args - the month and day of the month.

Returns:

  • the millisecond representation of the adjusted date.

setHours(Number, Number...) 
setHours(hours: Number, args: Number...): Number

Sets the hours field of this Date instance. The minutes value should be a Number from 0 to 23. Optionally, hours, seconds and milliseconds can also be provided.

Parameters:

  • hours - the minutes field of this Date instance.
  • args - the hours, seconds and milliseconds values for this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setMilliseconds(Number) 
setMilliseconds(millis: Number): Number

Sets the milliseconds field of this Date instance.

Parameters:

  • millis - the milliseconds field of this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setMinutes(Number, Number...) 
setMinutes(minutes: Number, args: Number...): Number

Sets the minutes field of this Date instance. The minutes value should be a Number from 0 to 59. Optionally, seconds and milliseconds can also be provided.

Parameters:

  • minutes - the minutes field of this Date instance.
  • args - the seconds and milliseconds value for this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setMonth(Number, Number...) 
setMonth(month: Number, date: Number...): Number

Sets the month of the year where the value is a Number from 0 to 11. Optionally, you can set the day of the month.

Parameters:

  • month - the month of the year.
  • date - the day of the month.

Returns:

  • the millisecond representation of the adjusted date.

setSeconds(Number, Number...) 
setSeconds(seconds: Number, millis: Number...): Number

Sets the seconds field of this Date instance. The seconds value should be a Number from 0 to 59. Optionally, milliseconds can also be provided.

Parameters:

  • seconds - the seconds field of this Date instance.
  • millis - the milliseconds field of this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setTime(Number) 
setTime(millis: Number): Number

Sets the number of milliseconds between the desired date and time and January 1, 1970.

Parameters:

  • millis - the number of milliseconds between the desired date and time and January 1, 1970.

Returns:

  • the millisecond representation of the adjusted date.

setUTCDate(Number) 
setUTCDate(date: Number): Number

Sets the day of the month, expressed in universal time, where the value is a Number from 1 to 31.

Parameters:

  • date - the day of the month, expressed in universal time.

Returns:

  • the millisecond representation of the adjusted date.

setUTCFullYear(Number, Number...) 
setUTCFullYear(year: Number, args: Number...): Number

Sets the full year, expressed in universal time, of Date where the value must be a four-digit Number. Optionally, you can set the month and date.

Parameters:

  • year - the year as a four-digit Number, expressed in universal time.
  • args - the month and day of the month.

Returns:

  • the millisecond representation of the adjusted date.

setUTCHours(Number, Number...) 
setUTCHours(hours: Number, args: Number...): Number

Sets the hours field, expressed in universal time, of this Date instance. The minutes value should be a Number from 0 to 23. Optionally, seconds and milliseconds can also be provided.

Parameters:

  • hours - the minutes field, expressed in universal time, of this Date instance.
  • args - the seconds and milliseconds value, expressed in universal time, for this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setUTCMilliseconds(Number) 
setUTCMilliseconds(millis: Number): Number

Sets the milliseconds field, expressed in universal time, of this Date instance.

Parameters:

  • millis - the milliseconds field, expressed in universal time, of this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setUTCMinutes(Number, Number...) 
setUTCMinutes(minutes: Number, args: Number...): Number

Sets the minutes field, expressed in universal time, of this Date instance. The minutes value should be a Number from 0 to 59. Optionally, seconds and milliseconds can also be provided.

Parameters:

  • minutes - the minutes field, expressed in universal time, of this Date instance.
  • args - the seconds and milliseconds values, expressed in universal time, for this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

setUTCMonth(Number, Number...) 
setUTCMonth(month: Number, date: Number...): Number

Sets the month of the year, expressed in universal time, where the value is a Number from 0 to 11. Optionally, you can set the day of the month.

Parameters:

  • month - the month of the year, expressed in universal time.
  • date - the day of the month.

Returns:

  • the millisecond representation of the adjusted date.

setUTCSeconds(Number, Number...) 
setUTCSeconds(seconds: Number, millis: Number...): Number

Sets the seconds field, expressed in universal time, of this Date instance. The seconds value should be a Number from 0 to 59. Optionally, milliseconds can also be provided.

Parameters:

  • seconds - the seconds field, expressed in universal time, of this Date instance.
  • millis - the milliseconds field, expressed in universal time, of this Date instance.

Returns:

  • the millisecond representation of the adjusted date.

toDateString() 
toDateString(): String

Returns the Date as a String value where the value represents the date portion of the Date in the default locale (en_US). To format a calendar object in an alternate format use the dw.util.StringUtils.formatCalendar() functions instead.

Returns:

  • the Date as a String value.

toISOString() 
toISOString(): String

This function returns a string value represent the instance in time represented by this Date object. The date is formatted with the Simplified ISO 8601 format as follows: YYYY-MM-DDTHH:mm:ss.sssTZ. The time zone is always UTC, denoted by the suffix Z.

Returns:

  • string representation of this date

toJSON(String) 
toJSON(key: String): Object

This function returns the same string as Date.prototype.toISOString(). The method is called when a Date object is stringified.

Parameters:

  • key - the name of the key, which is stringified

Returns:

  • JSON string representation of this date

toLocaleDateString() 
toLocaleDateString(): String

Returns the Date as a String value where the value represents the date portion of the Date in the default locale (en_US). To format a calendar object in an alternate format use the dw.util.StringUtils.formatCalendar() functions instead.

Returns:

  • returns the date portion of the Date as a String.

toLocaleString() 
toLocaleString(): String

Returns the Date as a String using the default locale (en_US). To format a calendar object in an alternate format use the dw.util.StringUtils.formatCalendar() functions instead.

Returns:

  • the Date as a String using the default locale en_US

toLocaleTimeString() 
toLocaleTimeString(): String

Returns the Date as a String value where the value represents the time portion of the Date in the default locale (en_US). To format a calendar object in an alternate format use the dw.util.StringUtils.formatCalendar() functions instead.

Returns:

  • returns the time time's portion of the Date as a String.

toTimeString() 
toTimeString(): String

Returns the Date as a String value where the value represents the time portion of the Date in the default locale (en_US). To format a calendar object in an alternate format use the dw.util.StringUtils.formatCalendar() functions instead.

Returns:

  • the Date's time.

toUTCString() 
toUTCString(): String

Returns a String representation of this Date, expressed in universal time.

Returns:

  • a String representation of this Date, expressed in universal time.

valueOf() 
valueOf(): Object

Returns the value of this Date represented in milliseconds.

Returns:

  • the value of this Date represented in milliseconds.

Open Commerce API (deprecated)
Shop Baskets (deprecated)
Shop Categories (deprecated)
Shop Content (deprecated)
Shop Content Search (deprecated)
Shop Custom Objects (deprecated)
Shop Customers (deprecated)
Shop Folders (deprecated)
Shop Gift Certificate (deprecated)
Shop Order Search (deprecated)
Shop Orders (deprecated)
Shop Price Adjustment Limits (deprecated)
Shop Product Lists (deprecated)
Shop Product Search (deprecated)
Shop Products (deprecated)
Shop Promotions (deprecated)
Shop Search Suggestion (deprecated)
Shop Sessions (deprecated)
Shop Site (deprecated)
Shop Stores (deprecated)
Data A/B Test Search (deprecated)
Data A/B Tests (deprecated)
Data Alerts (deprecated)
Data Campaign Search (deprecated)
Data Campaigns (deprecated)
Data Cartridges (deprecated)
Data Catalog Search (deprecated)
Data Catalogs (deprecated)
Data Category Search (deprecated)
Data Code Versions (deprecated)
Data Coupon Redemption Search (deprecated)
Data Coupon Search (deprecated)
Data Coupons (deprecated)
Data Custom Object Definitions (deprecated)
Data Custom Objects (deprecated)
Data Custom Objects Search (deprecated)
Data Customer Group Search (deprecated)
Data Customer Groups (deprecated)
Data Customer Lists (deprecated)
Data Gift Certificate Search (deprecated)
Data Gift Certificates (deprecated)
Data Global Custom Objects (deprecated)
Data Global Locale Info (deprecated)
Data Global Preferences (deprecated)
Data Global Site Preferences (deprecated)
Data Inventory List Search (deprecated)
Data Inventory Lists (deprecated)
Data Job Execution Search (deprecated)
Data Jobs (deprecated)
Data Libraries (deprecated)
Data Locale Info (deprecated)
Data Log Requests (deprecated)
Data Metrics (deprecated)
Data OCAPI Configs (deprecated)
Data Orders (deprecated)
Data Permissions (deprecated)
Data Product Search (deprecated)
Data Products (deprecated)
Data Promotion Campaign Assignment Search (deprecated)
Data Promotion Search (deprecated)
Data Promotions (deprecated)
Data Recommender Names (deprecated)
Data Role Search (deprecated)
Data Roles (deprecated)
Data Settings (deprecated)
Data Site Preferences (deprecated)
Data Site Search (deprecated)
Data Sites (deprecated)
Data Slot Configuration Campaign Assignment Search (deprecated)
Data Slot Configuration Search (deprecated)
Data Slot Configurations (deprecated)
Data Slot Search (deprecated)
Data Slots (deprecated)
Data Sorting Rule Search (deprecated)
Data Source Code Group Search (deprecated)
Data Source Code Groups (deprecated)
Data Store Search (deprecated)
Data Stores (deprecated)
Data System Object Definition Search (deprecated)
Data System Object Definitions (deprecated)
Data User Search (deprecated)
Data Users (deprecated)
Script API
B2C Commerce Script API 26.4
TopLevel
APIException
arguments
Array
ArrayBuffer
BigInt
Boolean
ConversionError
DataView
Date
Error
ES6Iterator
EvalError
Fault
Float32Array
Float64Array
Function
Generator
global
Int16Array
Int32Array
Int8Array
InternalError
IOError
Iterable
Iterator
JSON
Map
Math
Module
Namespace
Number
Object
QName
RangeError
ReferenceError
RegExp
Set
StopIteration
String
Symbol
SyntaxError
SystemError
TypeError
Uint16Array
Uint32Array
Uint8Array
Uint8ClampedArray
URIError
WeakMap
WeakSet
XML
XMLList
XMLStreamError
dw.alert
dw.campaign
dw.catalog
dw.content
dw.crypto
dw.customer
dw.customer.oauth
dw.customer.shoppercontext
dw.experience
dw.experience.cms
dw.experience.image
dw.extensions.applepay
dw.extensions.facebook
dw.extensions.paymentapi
dw.extensions.paymentrequest
dw.extensions.payments
dw.extensions.pinterest
dw.io
dw.job
dw.net
dw.object
dw.order
dw.order.hooks
dw.rpc
dw.sitemap
dw.suggest
dw.svc
dw.system
dw.template
dw.util
dw.value
dw.web
dw.ws
B2C Commerce Developer Sandbox REST API

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!