Manage addresses

Get an address by ID

To get an address by ID, specify the ID of the address in the {addressId} URI path parameter.

GEThttps://api.digitalriver.com/v1/shoppers/me/addresses/{addressId}

Path parameters

addressId*string

The address ID.

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultShopperAddressById (object)ExpandedShopperAddressById (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/addresses/{addressId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "address": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/addresses/1234567890",
    "id": 1655007697,
    "nickName": "test",
    "isDefault": "true",
    "firstName": "Jon",
    "lastName": "Doe",
    "line1": "10380 Bren Road West",
    "line2": "text",
    "city": "Minnetonka",
    "countrySubdivision": "MN",
    "postalCode": "55343",
    "country": "US",
    "countryName": "United States",
    "phoneNumber": "952-253-1234",
    "phoneticFirstName": "クリス",
    "phoneticLastName": "ミラー",
    "division": "製品開発"
  }
}

Delete a shoppers address

To delete the shopper's address, specify the address identifier in the {addressId} URI path parameter. No warning message appears if you delete the last address linked to the shopper.

DELETEhttps://api.digitalriver.com/v1/shoppers/me/addresses/{addressId}

Path parameters

addressId*string

The address ID.

Query parameters

Response

204401

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/addresses/{addressId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401

{
  "errors": {
    "error": [
      {
        "code": "invalid-token",
        "description": "Invalid Token for Shopper Session"
      }
    ]
  }
}

Get all shopper addresses

Retrieve all addresses configured for a shopper, such as home and work addresses. If you need to access a billing or shipping address, use the methods available in the Carts API.

GEThttps://api.digitalriver.com/v1/shoppers/me/addresses

Query parameters

Response

200401

Successful response.

Body

application/json

one of

DefaultShopperAddresses (object)ExpandedShopperAddresses (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/addresses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "addresses": {
    "uri": "https://api.digitalriver.com/v1/shoppers/me/addresses",
    "address": [
      {
        "uri": "https://api.digitalriver.com/v1/shoppers/me/addresses/1234567890",
        "nickName": "test",
        "isDefault": "true"
      }
    ]
  }
}

Create or update shopper address

Create or update a shopper's address. Each address entry must have a unique nickname. If a current address has the same nickname specified in the request, that address is updated; otherwise, the request creates a new address.

POSThttps://api.digitalriver.com/v1/shoppers/me/addresses

Query parameters

Body

application/json

Address for the shopper.

addressobject

Response

204401

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/shoppers/me/addresses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401

{
  "errors": {
    "error": [
      {
        "code": "invalid-token",
        "description": "Invalid Token for Shopper Session"
      }
    ]
  }
}