v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

List

Returns an array of all addresses available to the merchant.

get/addresses/

Query parameters

customerstring

Customer ID (only available in API user scope)

liveboolean

Address status: active (True) or inactive (False)

updated_startstring date

Addresses whose updated datetime is greater than or equal to the given datetime (yyyy-mm-ddThh:mm:ss)

updated_endstring date

Addresses whose updated datetime is less than or equal to the given datetime (yyyy-mm-ddThh:mm:ss)

Response

200

customerstring

public_idstring

{"stackTrail":"paths:/addresses/:get:responses:200:content:application/json:schema:properties:label","oasType":"schema","type":"unknown"}

first_namestring

last_namestring

{"stackTrail":"paths:/addresses/:get:responses:200:content:application/json:schema:properties:company_name","oasType":"schema","type":"unknown"}

addressstring

{"stackTrail":"paths:/addresses/:get:responses:200:content:application/json:schema:properties:address2","oasType":"schema","type":"unknown"}

citystring

state_province_codestring

zip_postal_codestring

phonestring

{"stackTrail":"paths:/addresses/:get:responses:200:content:application/json:schema:properties:fax","oasType":"schema","type":"unknown"}

country_codestring

liveboolean

createdstring

updatedstring

{"stackTrail":"paths:/addresses/:get:responses:200:content:application/json:schema:properties:token_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/addresses/:get:responses:200:content:application/json:schema:properties:store_public_id","oasType":"schema","type":"unknown"}

Example response

{
  "customer": "00026001",
  "public_id": "c4cd7f86ccc411e8ada3bc764e101db1",
  "first_name": "Nathan",
  "last_name": "Torres",
  "address": "75 Broad St Fl 23",
  "city": "New York",
  "state_province_code": "NY",
  "zip_postal_code": "10004-2487",
  "phone": "3154055372",
  "country_code": "US",
  "live": true,
  "created": "2018-10-10 14:43:32",
  "updated": "2018-10-10 14:43:32"
}

All 92 operations