ERerply
Addresses

Get addresses

get/v1/addresses

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

matchstring

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

idsinteger[]

address 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.

customerIdsinteger[]

customer Id

typeIdsinteger[]

address type Id

streetstring

street

address2string

address2

postCodestring

post Code

citystring

city

countrystring

country

statestring

state

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

address2string

Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!

changedinteger

Unix timestamp

changedBystring

username

citystring
countrystring
customerIdinteger
idinteger

object ID

postCodestring

Postal code or ZIP code.

statestring

State. This field is exposed via Erply user interface only for US, CA and MX accounts!

streetstring

Street address. If address cannot be split into parts, put the whole address into this field.

typeIdinteger

Example response

[
  {
    "added": 1595230999,
    "addedBy": "k@erp.xyz",
    "changed": 1595230999,
    "changedBy": "k@erp.xyz",
    "id": 1234
  }
]

Changes

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