API Docs
Home
References
  • Product API
  • Product Inventory API
Home
References
  • Product API
  • Product Inventory API
  1. API
  2. Config
  • Overview
  • Getting Started
  • Common Errors
  • API
    • Config
      • List Pickup Address
        GET
      • List Box Dimension
        GET
      • List vendor
        GET
      • List store
        GET
    • Product
      • Options
        • List category
        • List brand
      • Create Single Product
      • List product
      • Product detail
      • Create Product From Product Inventory
    • Product Inventory
      • Options
        • List Outbound Strategy
        • List Product Type
        • List Material
        • List Storage Method
      • List product inventory
      • Product inventory detail
      • Create single inventory product
    • Order
      • Shipping Service
        • Preview shipping prices
          • List available courier
          • List shipping service
        • List available courier from order
        • List shipping service of courier
      • Create order B2C
      • List order
      • Order detail
      • Cancel order
    • Shipment
      • Create shipment auto
      • Cancel shipment
      • [Retail][Ship by self] Create shipment with item
    • Shipment Inbound
      • Create shipment inbound
      • List shipment inbound
      • Shipment inbound detail
      • Shipment inbound items
    • Courier
      • List courier service integrated
      • List courier operate
      • List courier integrated
    • Address Directory
      • Province
      • District
      • Ward
  • Status
    • SHIPMENT INBOUND
    • ORDER
    • SHIPMENT
    • RETURN
  • Webhooks
    • WebHook connection required
    • HOOK EVENT ORDER CREATED
    • HOOK EVENT ORDER UPDATE STATUS
    • HOOK EVENT SHIPMENT CREATED
    • HOOK EVENT SHIPMENT UPDATE STATUS
    • HOOK EVENT INBOUND UPDATE STATUS
    • HOOK EVENT INBOUND CREATED
    • HOOK EVENT STOCK UPDATE
  1. API
  2. Config

List Pickup Address

Developing
GET
/api/v1/public/users/pickup-address/list
Last modified:2024-08-08 03:28:26

Request

Query Params
page
string 
optional
Example:
1
page_size
string 
optional
Example:
5
Header Params
Authorization
string 
optional
Default:
6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://stg-oms.nandh.vn/api/v1/public/users/pickup-address/list?page=1&page_size=5' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ=='

Responses

🟢200OK
application/json
Body
status_code
integer 
required
data
array [object {24}] 
optional
id
integer 
required
user
integer 
required
business
integer 
required
country
string 
required
platform
null 
required
is_default
boolean 
required
is_active
boolean 
required
fulfillment_provider
string 
required
warehouse_provider
string 
required
pickup_name
string 
required
contact_name
string 
required
phone
string 
required
address
string 
required
lat
integer 
required
lng
integer 
required
zipcode
null 
required
province
object 
required
district
object 
required
ward
object 
required
pickup_code
string 
required
fulfillment_provider_name
string 
required
warehouse_provider_name
string  | null 
required
is_fulfill_self
boolean 
required
is_fulfill_3pf
boolean 
required
error
boolean 
optional
error_code
null 
optional
log_id
null 
optional
messages
string  | null 
optional
total
integer  | null 
optional
Example
{
  "status_code": 0,
  "data": [
    {
      "id": 0,
      "user": 0,
      "business": 0,
      "country": "string",
      "platform": null,
      "is_default": true,
      "is_active": true,
      "fulfillment_provider": "string",
      "warehouse_provider": "string",
      "pickup_name": "string",
      "contact_name": "string",
      "phone": "string",
      "address": "string",
      "lat": 0,
      "lng": 0,
      "zipcode": null,
      "province": {
        "id": 0,
        "country": "string",
        "code": "string",
        "province_name": "string"
      },
      "district": {
        "id": 0,
        "country": "string",
        "province_id": 0,
        "district_name": "string"
      },
      "ward": {
        "id": 0,
        "province_id": 0,
        "district_id": 0,
        "country": "string",
        "ward_name": "string"
      },
      "pickup_code": "string",
      "fulfillment_provider_name": "string",
      "warehouse_provider_name": "string",
      "is_fulfill_self": true,
      "is_fulfill_3pf": true
    }
  ],
  "error": true,
  "error_code": null,
  "log_id": null,
  "messages": "string",
  "total": 0
}
Modified at 2024-08-08 03:28:26
Previous
Common Errors
Next
List Box Dimension
Built with