Function /order/list
Function invocation
https://json.aftermarket.pl/order/list
Function description
Returns the list of ordered operations.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| name | string | "" | String to be searched in domain names | |
| string | "" | String to be searched in domain names (deprecated, please use 'name' parameter) | ||
| order | string | "expires" | List sorting (can be sorted by expires, time, name) | |
| size | integer | 5000 | Paging: number of list elements | |
| start | integer | 0 | Paging: starting list element | |
| integer | 0 | Paging: page number (deprecated, please use 'start' parameter) | ||
| integer | 0 | Sort type (1 => name, 2 => order expiration) (deprecated and unused, pleaase use 'order' parameter) | ||
| integer | 5000 | Paging: number of list elements (deprecated, please use 'size' parameter) | ||
| state | integer | 0 | Filter by state of order (0 - all orders, 1 - suspended orders, 2 - not suspended orders) | |
| type | string | "" | Filter by type of order (one of register, renew, transfer, buy, market, future, util, loan ) |
Return value
List of user ordered operations (list of structures with the following fields):
| Field name | Type | Description |
|---|---|---|
| orderId | integer | Order identifier |
| name | string | Domain name (in Punycode) |
| nameIDN | string | Domain name (internationalized) |
| string | Domain name (internationalized) (deprecated, please use 'nameIDN' field) | |
| suspended | boolean | Order suspended |
| time | integer | Time as Unix timestamp when order was created |
| expires | integer | Time as Unix timestamp when order will expire |
| type | string | Type of order (register, renew, transfer, buy, market, future, util, loan) |
| description | string | Order type description |
| cost | float | Cost in main currency |
| currency | string | Main currency |