Function   /buyer/expiring/option/list

Function invocation

Function description

Returns a list of expiring options. The expring options list is searched according to specified name. Name parameter is optional and can be omitted.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
name string "" String to be searched in option names
order string "name" List sorting (one of: name, expires)
size integer 5000 Paging: number of list elements
start integer 0 Paging: starting list element

Return value

List of expring options (list of structures with the following fields):

Field nameTypeDescription
date string Option expires date (in yyyy-mm-dd format) (deprecated, this value now given in 'expires' field)
deletedOptionId integer Expring option identifier (deprecated and unused)
expires string Option expires date (in yyyy-mm-dd format)
expiresTime integer Option expires time as Unix timestamp
name string Option name (in Punycode)
utfname string Option name (internationalized) (deprecated, this value is given in 'nameIDN' field)
nameIDN string Option name (internationalized)
time string Option expires time (in hh-mm-ss format) (deprecated, expiration hour is now given in 'expiresTime' field)