Skip to main content

Addresses

Manage addresses for an existing consumer profile to help you keep your consumers' addresses current, so you can ship items and make transactions seamlessly, using the the Consumer Profile Management API. You can have multiple addresses in a consumer profile.

Add an address to a consumer profile

You can add a new address to an existing consumer profile by sending a POST request to the /consumer-profiles/{consumer-profile-id}/addresses endpoint.

HTTP method: POST

Endpoint: /consumer-profiles/PACJGQ/addresses

Scenario: Adding a new address to the consumer profile with consumer-profile-id = PACJGQ

Json
{
    "firstName": "John",
    "lastName": "Doe",
    "consumerAssignedAddressName": "Work2",
    "primaryAddressIndicator": true,
    "addressType": "SHIPPING",
    "line1": "200 Elton Farm",
    "line2": "Apt 123",
    "city": "Glen Mills",
    "state": "PA",
    "postalCode": "19342",
    "countryCode": "USA",
    "addressStatus": "ACTIVE"
}

Response:

Json
{
    "consumerProfileId": "PACJGQ",
    "cardOnFileReferenceNumber": "",
    "firstName": "John",
    "lastName": "Doe",
    "communication": {
        "phoneList": [
            {
                "phoneNumber": "8888888828",
                "countryCode": "1",
                "phoneNumberType": "Home",
                "communicationIdentifier": "HH04423498968"
            }
        ],
        "emailList": [
            {
                "emailAddress": "john.doe.x@gmail.com",
                "emailAddressType": "Home",
                "communicationIdentifier": "EE8141240230923"
            }
        ]
    },
    "paymentMethodType": {
        "cardList": [
            {
                "paymentMethodId": "77ccba29-4857-494a-82bc-2a80e1fa2b9d",
                "cardExpirationMonthYearNumber": "01/2025",
                "last4CardNumber": "9999",
                "cardType": "MC",
                "firstName": "John",
                "lastName": "Doe",
                "addressIdentifier": "8d452494-ec75-4ef9-9b45-e4bd7debf6a0"
            }
        ]
    },
    "addresses": [
        {
            "addressIdentifier": "8d452494-ec75-4ef9-9b45-e4bd7debf6a0",
            "firstName": "John",
            "lastName": "Doe",
            "consumerAssignedAddressName": "Work",
            "primaryAddressIndicator": true,
            "addressType": "SHIPPING",
            "line1": "100 Elton Farm",
            "line2": "Apt 123",
            "city": "Glen Mills",
            "state": "PA",
            "postalCode": "19342",
            "countryCode": "USA",
            "addressStatus": "ACTIVE"
        },
        {
            "addressIdentifier": "e17a1ecd-b177-4c3d-a99b-c72e132b260f",
            "firstName": "John",
            "lastName": "Doe",
            "consumerAssignedAddressName": "Work2",
            "primaryAddressIndicator": true,
            "addressType": "SHIPPING",
            "line1": "200 Elton Farm",
            "line2": "Apt 123",
            "city": "Glen Mills",
            "state": "PA",
            "postalCode": "19342",
            "countryCode": "USA",
            "addressStatus": "ACTIVE"
        }
    ],
    "correlationIdentifier": "04ee743b-b33e-4867-a94b-b92003fce9ce",
    "createTimestamp": "2021-08-23T00:23:05.353Z",
    "createUserIdentifier": "jack",
    "updateTimestamp": "2024-07-02T10:07:04.400Z",
    "updateUserIdentifier": "jack",
    "profileStatus": "ACTIVE"
}

Manage addresses on a consumer profile

You can manage the addresses on a consumer profile using the following actions:

  1. Add a new address to a consumer profile
  2. Update an address
  3. Delete an address

To learn more about how to manage addresses, refer to Manage addresses for a consumer profile.

Manage addresses for a consumer profile
Manage payment methods for a consumer profile
Manage communication methods for a consumer profile