📍 Delivery Addresses

Delivery address management and configuration endpoints. 9 endpoints available.

🎯 Quick Stats

Total Endpoints: 9
Base URL: https://api.market.decenctype.com
Authentication: Bearer Token / API Key

📊 Methods

📝 POST: 1 endpoints
🔍 GET: 5 endpoints
✏️ PUT: 2 endpoints
🗑️ DELETE: 1 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

Method	Endpoint	Description
📝 `POST`	`/delivery/address`	Create delivery address
🔍 `GET`	`/delivery/address`	Get user address list
🔍 `GET`	`/delivery/address/merchant/{merchantId}`	Get merchant address list
🔍 `GET`	`/delivery/address/pagination`	Get paginated address list
🔍 `GET`	`/delivery/address/{deliveryAddressId}`	Get address details
✏️ `PUT`	`/delivery/address/{deliveryAddressId}`	Update address
🗑️ `DELETE`	`/delivery/address/{deliveryAddressId}`	Delete address
✏️ `PUT`	`/delivery/address/{deliveryAddressId}/default`	Set default address
🔍 `GET`	`/delivery/address/default/current`	Get current default address

📖 Detailed Documentation

Create delivery address

POST/delivery/address

Full URL

https://api.market.decenctype.com/delivery/address

📝 Request Body Parameters

Parameter	Type	Required	Description
`userId`	`string`	❌	用户ID
`merchantId`	`string`	❌	商户ID
`type`	`string (user, merchant)`	✅	类型
`recipientTitle`	`string`	❌	收件人称谓 (Mr./Ms./Mrs./Dr.)
`firstName`	`string`	✅	名
`lastName`	`string`	✅	姓
`nationality`	`string`	✅	国家码 (ISO 3166-1)
`addressState`	`string`	❌	州/省 (如美国的 CA, NY 等)
`city`	`string`	✅	城市
`line1`	`string`	✅	详细地址
`line2`	`string`	✅	详细地址2
`postalCode`	`string`	✅	邮编
`phoneAreaCode`	`string`	✅	电话区号
`phoneNumber`	`string`	✅	电话号码
`email`	`string`	✅	邮箱地址
`alias`	`string`	✅	别名, 用于快速区分不同地址
`defaultFlag`	`boolean`	✅	是否设置默认

Description: Create delivery address

Operation ID: createAddress

Response Status:

✅ 201: Address created successfully

📋 Response Examples

response.json

1{
2  "deliveryAddressId": "example-id",
3  "userId": "example-id",
4  "merchantId": "example-id",
5  "type": {},
6  "recipientTitle": "example-recipientTitle",
7  "firstName": "example-firstName",
8  "lastName": "example-lastName",
9  "nationality": "example-nationality",
10  "addressState": "example-addressState",
11  "city": "example-city",
12  "line1": "example-line1",
13  "line2": "example-line2",
14  "postalCode": "example-postalCode",
15  "phoneAreaCode": "example-phoneAreaCode",
16  "phoneNumber": "example-phoneNumber",
17  "email": "user@example.com",
18  "alias": "example-alias",
19  "defaultFlag": true,
20  "user": "example-user",
21  "merchant": "example-merchant"
22}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/delivery/address" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "type": "user",
  "firstName": "example-firstName",
  "lastName": "example-lastName",
  "nationality": "example-nationality",
  "city": "example-city",
  "line1": "example-line1",
  "line2": "example-line2",
  "postalCode": "example-postalCode",
  "phoneAreaCode": "example-phoneAreaCode",
  "phoneNumber": "example-phoneNumber",
  "email": "user@example.com",
  "alias": "example-alias",
  "defaultFlag": true
}'

Get user address list

GET/delivery/address

Full URL

https://api.market.decenctype.com/delivery/address

🔐 Authentication: Required (see authentication section above)

Description: Get user address list

Operation ID: getAddressList

Response Status:

✅ 200: Address list retrieved successfully

📋 Response Examples

response.json

1[
2  {
3    "deliveryAddressId": "example-id",
4    "userId": "example-id",
5    "merchantId": "example-id",
6    "type": {},
7    "recipientTitle": "example-recipientTitle",
8    "firstName": "example-firstName",
9    "lastName": "example-lastName",
10    "nationality": "example-nationality",
11    "addressState": "example-addressState",
12    "city": "example-city",
13    "line1": "example-line1",
14    "line2": "example-line2",
15    "postalCode": "example-postalCode",
16    "phoneAreaCode": "example-phoneAreaCode",
17    "phoneNumber": "example-phoneNumber",
18    "email": "user@example.com",
19    "alias": "example-alias",
20    "defaultFlag": true,
21    "user": "example-user",
22    "merchant": "example-merchant"
23  }
24]

📝 Example Request

curl -X GET "https://api.market.decenctype.com/delivery/address" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get merchant address list

GET/delivery/address/merchant/{merchantId}

Full URL

https://api.market.decenctype.com/delivery/address/merchant/{merchantId}

🎯 Path Parameters

merchantId (string) - ✅ Required: Merchant ID

Description: Get merchant address list

Operation ID: getMerchantAddressList

Response Status:

✅ 200: Merchant address list retrieved successfully

📋 Response Examples

response.json

1[
2  {
3    "deliveryAddressId": "example-id",
4    "userId": "example-id",
5    "merchantId": "example-id",
6    "type": {},
7    "recipientTitle": "example-recipientTitle",
8    "firstName": "example-firstName",
9    "lastName": "example-lastName",
10    "nationality": "example-nationality",
11    "addressState": "example-addressState",
12    "city": "example-city",
13    "line1": "example-line1",
14    "line2": "example-line2",
15    "postalCode": "example-postalCode",
16    "phoneAreaCode": "example-phoneAreaCode",
17    "phoneNumber": "example-phoneNumber",
18    "email": "user@example.com",
19    "alias": "example-alias",
20    "defaultFlag": true,
21    "user": "example-user",
22    "merchant": "example-merchant"
23  }
24]

📝 Example Request

curl -X GET "https://api.market.decenctype.com/delivery/address/merchant/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get paginated address list

GET/delivery/address/pagination

Full URL

https://api.market.decenctype.com/delivery/address/pagination

📋 Query Parameters

Parameter	Type	Required	Description
`page`	`string`	❌	Page number (示例: `1`)
`pageSize`	`string`	❌	Items per page (示例: `10`)
`search`	`string`	❌	Search keyword
`merchantId`	`string`	❌	Merchant ID for merchant addresses

Description: Get paginated address list

Operation ID: getAddressListWithPagination

Response Status:

✅ 200: Paginated address list retrieved successfully

📝 Example Request

curl -X GET "https://api.market.decenctype.com/delivery/address/pagination" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get address details

GET/delivery/address/{deliveryAddressId}

Full URL

https://api.market.decenctype.com/delivery/address/{deliveryAddressId}

🎯 Path Parameters

deliveryAddressId (string) - ✅ Required: Address ID

Description: Get address details

Operation ID: getAddressById

Response Status:

✅ 200: Address details retrieved successfully

📋 Response Examples

response.json

1{
2  "deliveryAddressId": "example-id",
3  "userId": "example-id",
4  "merchantId": "example-id",
5  "type": {},
6  "recipientTitle": "example-recipientTitle",
7  "firstName": "example-firstName",
8  "lastName": "example-lastName",
9  "nationality": "example-nationality",
10  "addressState": "example-addressState",
11  "city": "example-city",
12  "line1": "example-line1",
13  "line2": "example-line2",
14  "postalCode": "example-postalCode",
15  "phoneAreaCode": "example-phoneAreaCode",
16  "phoneNumber": "example-phoneNumber",
17  "email": "user@example.com",
18  "alias": "example-alias",
19  "defaultFlag": true,
20  "user": "example-user",
21  "merchant": "example-merchant"
22}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/delivery/address/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Update address

PUT/delivery/address/{deliveryAddressId}

Full URL

https://api.market.decenctype.com/delivery/address/{deliveryAddressId}

🎯 Path Parameters

deliveryAddressId (string) - ✅ Required: Address ID

Description: Update address

Operation ID: updateAddress

Response Status:

✅ 200: Address updated successfully

📋 Response Examples

response.json

1{
2  "deliveryAddressId": "example-id",
3  "userId": "example-id",
4  "merchantId": "example-id",
5  "type": {},
6  "recipientTitle": "example-recipientTitle",
7  "firstName": "example-firstName",
8  "lastName": "example-lastName",
9  "nationality": "example-nationality",
10  "addressState": "example-addressState",
11  "city": "example-city",
12  "line1": "example-line1",
13  "line2": "example-line2",
14  "postalCode": "example-postalCode",
15  "phoneAreaCode": "example-phoneAreaCode",
16  "phoneNumber": "example-phoneNumber",
17  "email": "user@example.com",
18  "alias": "example-alias",
19  "defaultFlag": true,
20  "user": "example-user",
21  "merchant": "example-merchant"
22}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/delivery/address/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Delete address

DELETE/delivery/address/{deliveryAddressId}

Full URL

https://api.market.decenctype.com/delivery/address/{deliveryAddressId}

🎯 Path Parameters

deliveryAddressId (string) - ✅ Required: Address ID

Description: Delete address

Operation ID: deleteAddress

Response Status:

✅ 200: Address deleted successfully

📋 Response Examples

response.json

1{
2  "deliveryAddressId": "example-id",
3  "userId": "example-id",
4  "merchantId": "example-id",
5  "type": {},
6  "recipientTitle": "example-recipientTitle",
7  "firstName": "example-firstName",
8  "lastName": "example-lastName",
9  "nationality": "example-nationality",
10  "addressState": "example-addressState",
11  "city": "example-city",
12  "line1": "example-line1",
13  "line2": "example-line2",
14  "postalCode": "example-postalCode",
15  "phoneAreaCode": "example-phoneAreaCode",
16  "phoneNumber": "example-phoneNumber",
17  "email": "user@example.com",
18  "alias": "example-alias",
19  "defaultFlag": true,
20  "user": "example-user",
21  "merchant": "example-merchant"
22}

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/delivery/address/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Set default address

PUT/delivery/address/{deliveryAddressId}/default

Full URL

https://api.market.decenctype.com/delivery/address/{deliveryAddressId}/default

🎯 Path Parameters

deliveryAddressId (string) - ✅ Required: Address ID

Description: Set default address

Operation ID: setDefaultAddress

Response Status:

✅ 200: Default address set successfully

📋 Response Examples

response.json

1{
2  "deliveryAddressId": "example-id",
3  "userId": "example-id",
4  "merchantId": "example-id",
5  "type": {},
6  "recipientTitle": "example-recipientTitle",
7  "firstName": "example-firstName",
8  "lastName": "example-lastName",
9  "nationality": "example-nationality",
10  "addressState": "example-addressState",
11  "city": "example-city",
12  "line1": "example-line1",
13  "line2": "example-line2",
14  "postalCode": "example-postalCode",
15  "phoneAreaCode": "example-phoneAreaCode",
16  "phoneNumber": "example-phoneNumber",
17  "email": "user@example.com",
18  "alias": "example-alias",
19  "defaultFlag": true,
20  "user": "example-user",
21  "merchant": "example-merchant"
22}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/delivery/address/example-id/default" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get current default address

GET/delivery/address/default/current

Full URL

https://api.market.decenctype.com/delivery/address/default/current

🔐 Authentication: Required (see authentication section above)

Description: Get current default address

Operation ID: getDefaultAddress

Response Status:

✅ 200: Default address retrieved successfully

📋 Response Examples

response.json

1{
2  "deliveryAddressId": "example-id",
3  "userId": "example-id",
4  "merchantId": "example-id",
5  "type": {},
6  "recipientTitle": "example-recipientTitle",
7  "firstName": "example-firstName",
8  "lastName": "example-lastName",
9  "nationality": "example-nationality",
10  "addressState": "example-addressState",
11  "city": "example-city",
12  "line1": "example-line1",
13  "line2": "example-line2",
14  "postalCode": "example-postalCode",
15  "phoneAreaCode": "example-phoneAreaCode",
16  "phoneNumber": "example-phoneNumber",
17  "email": "user@example.com",
18  "alias": "example-alias",
19  "defaultFlag": true,
20  "user": "example-user",
21  "merchant": "example-merchant"
22}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/delivery/address/default/current" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

📍 Delivery Addresses

🎯 Quick Stats

📊 Methods

🔑 Bearer Token (Recommended)

🔧 API Key

On this page