ORordergroove

List

Returns an array of all addresses available to the merchant.

get/addresses/

Request

  • Base URL
    https://restapi.ordergroove.com
  • Auth
    • none
    • or API key in header x-api-key

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
labelunknown
first_namestring
last_namestring
company_nameunknown
addressstring
address2unknown
citystring
state_province_codestring
zip_postal_codestring
phonestring
faxunknown
country_codestring
liveboolean
createdstring
updatedstring
token_idunknown
store_public_idunknown

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"
}

Changes

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