ERerply
Address Types

Get address types

Retrieve address types

get/v1/addresses/types

Request

Query parameters

matchstring

match type of the filtering. Supported values: =, >=, <=, contains, startswith. Default is =

idsinteger[]

address type Ids

changedinteger

Retrieve only items that have been added or modified at/after/before a specified timestamp. Use it to keep a local database in sync with Erply.

isActivelyUsedboolean

Indicates whether this is a type of actively used addresses, or a type of archived/old addresses. Address which has a type where isActivelyUsed=false cannot be used as a customer's shipping address on invoice.

orderBystring

field to order by

orderByDirection'ASC' | 'DESC'

direction to order by

skipinteger

skip n records

takeinteger

items to take, default: 20, max: 100000

withTotalCountboolean

optionally return total number of records in the X-Total-Count response header

Response

OK

addedinteger

Unix timestamp

addedBystring

username

changedinteger

Unix timestamp

changedBystring

username

idinteger

object ID

isActivelyUsedboolean

Example response

[
  {
    "added": 1595230999,
    "addedBy": "k@erp.xyz",
    "changed": 1595230999,
    "changedBy": "k@erp.xyz",
    "id": 1234,
    "name": {
      "ar": " ",
      "cs": " ",
      "da": " ",
      "de": " ",
      "el": " ",
      "en": " ",
      "es": " ",
      "et": " ",
      "fi": " ",
      "fo": " ",
      "fr": " ",
      "he": " ",
      "it": " ",
      "lt": " ",
      "lv": " ",
      "nl": " ",
      "no": " ",
      "pl": " ",
      "ru": " ",
      "sv": " ",
      "th": " ",
      "tr": " ",
      "vi": " ",
      "zh_Hans": " ",
      "zh_Hant": " "
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.