RErev-io
Addresses

Search for one or more addresses

Changed on

Search for one or more addresses.

get/v1/Addresses

Request

Query parameters

search.address_idinteger[]

Query by address identifier.

search.customer_idinteger[]

Query by account identifier.

search.citystring[]

Query by city.

search.state_or_provincestring[]

Query by 2-character state/province abbreviation.

search.postal_codestring[]

Query by postal code (i.e. zip)

search.line_1string[]

Query by primary address line.

search.line_2string[]

Query by secondary address line.

search.created_date_startstring date-time

Query by created date.

search.created_date_endstring date-time

Query by created date.

search.modified_date_startstring date-time

Query by modified date.

search.modified_date_endstring date-time

Query by modified date.

search.is_provider_validatedboolean

Query by provider validation (true or false).

search.is_USPS_validatedboolean

Query by USPS validation (true or false).

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

  • f175f5a3b11dRevision changes
    • warning

      added the new ANT enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ANT enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new ANT enum value to the // response property for the response status (media type: text/html)

    • warning

      added the new SCG enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new SCG enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new SCG enum value to the // response property for the response status (media type: text/html)

    • warning

      added the new YUG enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new YUG enum value to the // response property for the response status (media type: text/json)

    • warning

      added the new YUG enum value to the // response property for the response status (media type: text/html)