Update an address

PUT

/account/checkout-addresses/{checkout_address_id}

curl --request PUT \
  --url https://acme.mykreezalid.com/front_api/v1/account/checkout-addresses/4242 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "Home", "gender": "example", "first_name": "Jane", "last_name": "Doe", "business_name": "example", "address_line1": "12 rue de la Paix", "address_line2": "example", "address_zipcode": "75002", "address_city": "Paris", "address_state": "example", "address_country": "FR", "mobile": "+33612345678", "phone": "example" }'

• Your marketplace's address. A marketplace with a custom domain must be called on that domain instead (https://developers.kreezalid.com/getting-started/base-urls/).

Updates the fields you send on one of the signed-in member’s addresses; fields you leave out keep their value. An empty value for description, gender, first_name, last_name, address_line1, address_zipcode, address_city, address_country or mobile also keeps the current value, whereas an empty business_name, address_line2, address_state or phone clears it.

Authorizations

• bearerAuth

Parameters

Path Parameters

checkout_address_id

required

integer

Example

4242

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

Request Body^required

Media typeapplication/json

object

description

Label of the address.

string

Example

Home

gender

string

first_name

string

Example

Jane

last_name

string

Example

Doe

business_name

string

address_line1

string

Example

12 rue de la Paix

address_line2

string

address_zipcode

string

Example

75002

address_city

string

Example

Paris

address_state

string

address_country

Country code.

string

Example

FR

mobile

string

Example

+33612345678

phone

string

Responses

200

The address is updated.

Media typeapplication/json

object

status

string

message

string

data

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

id

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

{
  "status": "success",
  "message": "address updated",
  "data": {
    "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, the address does not exist or belongs to another member (no address with this id), or it could not be saved (can not save the entity).

Media typeapplication/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"
}