API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Config
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
      • List shipping service of courier
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
    • Return order detail
    • Create return order
    • Cancel Return Order
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Config

List Pickup Address

GET
/api/v1/public/users/pickup-address/list
This API retrieves a list of pickup addresses associated with a user. Each address includes detailed location and fulfillment information.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/users/pickup-address/list?page=1&page_size=5' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": [
    {
      "id": 167,
      "user": 190,
      "business": 276,
      "country": "VN",
      "platform": null,
      "is_default": false,
      "is_active": true,
      "fulfillment_provider": "nandh",
      "warehouse_provider": "NH_WH_HCM",
      "pickup_name": "BTH",
      "contact_name": "SHOP TEST IT",
      "phone": "0961557476",
      "address": "Đường An Phú Đông 13, An Phú Đông, Quận 12, Thành phố Hồ Chí Minh",
      "lat": 0,
      "lng": 0,
      "zipcode": null,
      "province": {
        "id": 79,
        "country": "VN",
        "code": "HCM",
        "province_name": "TP. Hồ Chí Minh"
      },
      "district": {
        "id": 761,
        "country": "VN",
        "province_id": 79,
        "district_name": "Quận 12"
      },
      "ward": {
        "id": 26779,
        "province_id": 79,
        "district_id": 761,
        "country": "VN",
        "ward_name": "Phường An Phú Đông"
      },
      "pickup_code": "PK100167",
      "fulfillment_provider_name": "N&H Logistics",
      "warehouse_provider_name": "FC HCM",
      "is_fulfill_self": false,
      "is_fulfill_3pf": true
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Request

Query Params
page
integer 
required
Example:
1
page_size
integer 
required
<= 100
Example:
5
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
HTTP response status code, e.g., 200 for success.
data
array [object {24}] 
optional
A list of pickup address objects with the following fields:
id
integer 
optional
Unique ID of the pickup address.
user
integer 
optional
ID of the user the address belongs to.
business
integer 
optional
ID of the associated business.
country
string 
optional
Country code (e.g., "VN" for Vietnam).
platform
string  | null 
optional
Platform information (can be null).
is_default
boolean 
optional
ndicates if this is the default pickup address (true/false).
is_active
boolean 
optional
Indicates if the address is active.
fulfillment_provider
string 
optional
Code for the fulfillment provider.
warehouse_provider
string 
optional
Code for the warehouse provider.
pickup_name
string 
optional
Internal name for the pickup location.
contact_name
string 
optional
Name of the contact person at the pickup location.
phone
string 
optional
Contact phone number.
address
string 
optional
Full textual address.
lat
integer 
optional
Latitude
lng
integer 
optional
Longitude
zipcode
string 
optional
Postal code (can be null).
province
object 
optional
district
object 
optional
ward
object 
optional
pickup_code
string 
optional
Unique code for the pickup address (e.g., "PK100167").
fulfillment_provider_name
string 
optional
Name of the fulfillment provider (e.g., "N&H Logistics").
warehouse_provider_name
string  | null 
optional
Name of the warehouse (e.g., "FC HCM").
is_fulfill_self
boolean 
optional
Indicates if self-fulfillment is enabled.
is_fulfill_3pf
boolean 
optional
Indicates if third-party fulfillment is enabled.
error
boolean 
optional
Indicates if an error occurred.
error_code
string  | null 
optional
Error code if any.
log_id
string  | null 
optional
Internal log ID for tracing.
messages
string  | null 
optional
Message content, usually empty on success.
total
integer  | null 
optional
Total number of pickup addresses returned.
Next
List Box Dimension
Built with