List saved addresses (paginated) | Jewelers Mutual Developer Docs

{
  "AddressResponse": [
    {
      "Address": {
        "Id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
        "ClientId": 1,
        "AddressType": 0,
        "Reference": "Main Warehouse",
        "Company": "Halvex Freight",
        "Contact": "John Doe",
        "AddressLine1": "1234 Elm Street",
        "AddressLine2": "Suite 567",
        "City": "Springfield",
        "State": "IL",
        "Zip": "62704",
        "CountryCode": "US",
        "PhoneNumber": "+1-217-555-1234",
        "EmailAddress": "contact@halvexfreight.com",
        "SendNotificationEmail": true,
        "Residential": true,
        "IgnoreBadAddress": true
      },
      "Error": [
        {
          "ErrorCode": "0",
          "ErrorMessage": ""
        }
      ]
    }
  ],
  "NextPageURL": "/api/v1/address/{type}/{pageNumNext}/{clientId}",
  "PreviousPageURL": "/api/v1/address/{type}/{pageNumPrev}/{clientId}"
}

Returns a paginated list of saved addresses filtered by type (ORIGIN=1, DESTINATION=2) and client ID. Use pageNum to step through large address books.

Path parameters

typeenumRequired

Address type filter. 0 = UNSPECIFIED, 1 = ORIGIN, 2 = DESTINATION

Allowed values:

pageNumintegerRequired

Comma separated list of page number.

clientIdintegerRequired

Comma separated list of client id.

Response

Returned if there are no http error. AddressResponse Error should still be verified as null or empty.

AddressResponselist of objects

NextPageURLstring

PreviousPageURLstring

Errors

400

Bad Request Error

404

Not Found Error

$	curl https://uat2.transguardian.com/api/v1/address/0/1/1 \
>	-H "API_KEY: API_KEY" \
>	-H "Authorization: Authorization"

Path parameters

Headers

Response

Errors