Member Delivery Address

Retrieve Member Delivery Address List

get

Function Description

• Retrieves the member's delivery address list.

---

Detailed Description

• Login is required.

• If the parameter baseDlvpYn is sent as Y, retrieves only the member delivery address registered as the default delivery address.

• If the parameter baseDlvpYn is sent as N/null, retrieves the entire delivery address list.

---

Revision History

• Release v2.00_240401: Added the maximum number of delivery addresses that can be saved to the Response DTO

Query parameters

baseDlvpYnString · enumOptional

Default Delivery Address Status

Example: YPossible values:

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

anyOptional

900

Business processing error details

*/*

get/v1/front/dlvpInfo

GET /api/member/v1/front/dlvpInfo HTTP/1.1
Host: api-member.x2bee.com/
Accept: */*

No content

Register Member Delivery Address

post

Function Description

• Registers a member's delivery address.

---

Detailed Description

• Login is required.

• Up to 10 delivery addresses can be registered.

• Returns the sequence number of the registered member delivery address after registration.

---

Notes

• After successful registration, the delivery address sequence number and delivery address information are synchronized to the event DB.

Revision History

• Release v1.06_231218: Delivery addresses can now be registered up to the reference1 value of common code ST017.

Header parameters

AuthorizationanyOptional

Access Token

Body

anyOptional

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

post/v1/front/dlvpInfo

POST /api/member/v1/front/dlvpInfo HTTP/1.1
Host: api-member.x2bee.com/
Content-Type: application/json
Accept: */*

text

Modify Member Delivery Address

put

Function Description

• Modifies the member delivery address.

---

Detailed Description

• Login is required.

• Cannot be modified if the member delivery address sequence number does not exist.

• If registered as the default delivery address, it cannot be unregistered as the default delivery address. (At least one default delivery address must exist.)

• Returns the sequence number of the modified member delivery address after modification.

---

Notes

• After a successful modification, the corresponding delivery address sequence number and delivery address information are synchronized to the event DB.

Header parameters

AuthorizationanyOptional

Access Token

Body

anyOptional

Responses

200

Success

*/*

stringOptional

900

Business processing error details

*/*

put/v1/front/dlvpInfo

PUT /api/member/v1/front/dlvpInfo HTTP/1.1
Host: api-member.x2bee.com/
Content-Type: application/json
Accept: */*

text

Delete Member Delivery Address

delete

Function Description

• Deletes a member's delivery address.

---

Detailed Description

• Login is required.

• Deletes the member delivery address matching the delivery address sequence number passed as a parameter.

• Cannot be deleted if the delivery address sequence number does not exist.

• Cannot be deleted if it is registered as the default delivery address. (At least one default delivery address must exist.)

---

Notes

• After successful deletion, the delivery address sequence number and delivery address information are synchronized to the event DB.

Query parameters

mbrDlvpSeqstringRequired

Member Delivery Address Sequence No.

Example: 1

userDetailstringRequired

UserDetail

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

No content

900

Business processing error details

*/*

delete/v1/front/dlvpInfo

DELETE /api/member/v1/front/dlvpInfo?mbrDlvpSeq=text&userDetail=text HTTP/1.1
Host: api-member.x2bee.com/
Accept: */*

No content

Save Member's Default Delivery Address

put

Function Description

• Changes the delivery address of the given member delivery address sequence number to the default delivery address.

---

Detailed Description

• Login is required.

• If it is registered as the default delivery address, it cannot be unset as the default. (At least one default delivery address must exist.)

• If the member delivery address sequence number does not exist, it cannot be changed to the default delivery address.

---

Notes

• After successful change, the delivery address sequence number and delivery address information are synchronized to the event DB.

• Default delivery address status (baseDlvpYn) can only be Y or N.

Query parameters

changeBaseDlvpRequeststringRequired

ChangeBaseDlvpRequest

userDetailstringRequired

UserDetail

Header parameters

AuthorizationanyOptional

Access Token

Body

anyOptional

Responses

200

Success

No content

900

Business processing error details

*/*

put/v1/front/dlvpDetailInfo

PUT /api/member/v1/front/dlvpDetailInfo?changeBaseDlvpRequest=text&userDetail=text HTTP/1.1
Host: api-member.x2bee.com/
Content-Type: application/json
Accept: */*

No content