Get an address

GET

/account/checkout-addresses/{checkout_address_id}

const url = 'https://acme.mykreezalid.com/front_api/v1/account/checkout-addresses/4242';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://acme.mykreezalid.com/front_api/v1/account/checkout-addresses/4242 \
  --header 'Authorization: Bearer <token>'

Returns one address of the signed-in member’s address book, as a bare object.

Authorizations

bearerAuth

Parameters

Path Parameters

checkout_address_id

required

integer

Example

Identifier of one of the signed-in member’s addresses.

Responses

200

The address.

application/json

An address saved in the signed-in member’s address book, to reuse at checkout.

object

object

A saved address of the signed-in member.

string

Unique identifier of the address.

integer

description

Label the member gives to the address.

string

nullable

gender

string

nullable

first_name

string

nullable

last_name

string

nullable

business_name

string

nullable

address_line1

string

nullable

address_line2

string

nullable

address_zipcode

string

nullable

address_city

string

nullable

address_state

string

nullable

address_country

Country code.

string

nullable

mobile

string

nullable

phone

string

nullable

Example

{
  "object": "CheckoutAddress",
  "id": 4242,
  "description": "Home",
  "first_name": "Jane",
  "last_name": "Doe",
  "address_line1": "12 rue de la Paix",
  "address_zipcode": "75002",
  "address_city": "Paris",
  "address_country": "FR",
  "mobile": "+33612345678"
}

403

No valid access token was sent, or the address does not exist or belongs to another member (no address with this id).

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}