Add an address

POST

/account/checkout-addresses

curl --request POST \
  --url https://acme.mykreezalid.com/front_api/v1/account/checkout-addresses \
  --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/).

Saves a new shipping address in the signed-in member’s address book.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

description

required

Label of the address.

string

Example

Home

gender

string

first_name

required

string

Example

Jane

last_name

required

string

Example

Doe

business_name

string

address_line1

required

string

Example

12 rue de la Paix

address_line2

string

address_zipcode

required

string

Example

75002

address_city

required

string

Example

Paris

address_state

string

address_country

required

Country code.

string

Example

FR

mobile

required

string

Example

+33612345678

phone

string

Responses

201

The address is saved.

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 created",
  "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.

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"
}

422

Required fields are missing; message lists them.

Media typeapplication/json

object

status

string

message

string

Example

{
  "status": "failed",
  "message": "missing fields : mobile, address_zipcode"
}

500

The address could not be saved.

Media typeapplication/json

object

status

string

message

string

Example

{
  "status": "failed",
  "message": "can not save the entity"
}