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 store

GET
/api/v1/public/stores/list
This API is used to retrieve a list of connected stores and sales channels linked to the system. This list is commonly used when manually creating an order, allowing users to select the appropriate store or sales channel for order processing.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/stores/list?page=1&page_size=50' \
--header 'Authorization;'
Response Response Example
{"status_code":200,"data":[{"id":481,"platform":"haravan","group_platform":"shopping","partner_id":"200000794109","partner_merchant_id":null,"currency":"VND","country":"VN","name":"NH Logistics","domain":"https://nh-logistics.myharavan.com/","url":"https://nh-logistics.myharavan.com/","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{"platform":"haravan","map_pickup":{"167":1590290},"map_location":{},"order_source":"in_platform","map_warehouse":{},"volume_default":"10x10x10","weight_default":"100","shop_description":"","update_fulfillment":"shipping_status","list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1744344826.0,"last_sync_order_time":1744344826.0,"created_time":1744344826.0,"updated_time":1744345143.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoharavan_1739504296.png","support_map_pickup":true,"is_merchant_shop":false},{"id":477,"platform":"nhanh","group_platform":"shopping","partner_id":"202093","partner_merchant_id":null,"currency":"VND","country":"VN","name":"nhanh824045489667","domain":null,"url":null,"logo":null,"description":"","expired_time":1773910714,"refresh_expired_time":null,"config":{"platform":"nhanh","map_pickup":{"167":207930},"map_location":{},"map_warehouse":{},"volume_default":"10x10x10","weight_default":"100","shop_description":"","sale_price_default":"1000","warehouse_allow_sync":"only_sync_linked_wh","list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":true,"is_active":true,"last_refresh_token_time":1742374714.0,"last_sync_order_time":1746601201.0,"created_time":1742348787.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/nhanhvn_1734314088.png","support_map_pickup":true,"is_merchant_shop":false},{"id":452,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1741971367.0,"last_sync_order_time":1741971367.0,"created_time":1741971367.0,"updated_time":1741971376.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":451,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1741971334.0,"last_sync_order_time":1741971334.0,"created_time":1741971334.0,"updated_time":1741971344.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":450,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1741971213.0,"last_sync_order_time":1741971213.0,"created_time":1741971213.0,"updated_time":1741971223.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":447,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":true,"is_active":true,"last_refresh_token_time":1741718066.0,"last_sync_order_time":1746601201.0,"created_time":1741718066.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":446,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1741717364.0,"last_sync_order_time":0.0,"created_time":1741717364.0,"updated_time":1741717374.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":445,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1741713996.0,"last_sync_order_time":0.0,"created_time":1741713996.0,"updated_time":1741714005.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":444,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1741713984.0,"last_sync_order_time":0.0,"created_time":1741713984.0,"updated_time":1741713993.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":375,"platform":"shopify","group_platform":"shopping","partner_id":"68917526550","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Tess store","domain":"https://tess-store-5944.myshopify.com","url":"https://tess-store-5944.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{"map_pickup":{"167":89790775318},"map_location":{},"map_warehouse":{},"list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":true,"is_active":true,"last_refresh_token_time":1730137031.0,"last_sync_order_time":1746601201.0,"created_time":1729798759.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":371,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{"map_pickup":{"167":89668026390},"map_location":{},"map_warehouse":{},"list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":true,"is_active":true,"last_refresh_token_time":1729185798.0,"last_sync_order_time":1746601201.0,"created_time":1729185798.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":366,"platform":"shopify","group_platform":"shopping","partner_id":"89138692406","partner_merchant_id":null,"currency":"VND","country":"VN","name":"xxistore.98","domain":"https://xxistore-98.myshopify.com","url":"https://xxistore-98.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{"map_pickup":{"167":100368482614},"map_location":{},"map_warehouse":{},"volume_default":"10x10x10","weight_default":"500","time_to_create_shipment":1,"list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":true,"is_active":true,"last_refresh_token_time":1728893103.0,"last_sync_order_time":1746601201.0,"created_time":1728893103.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":365,"platform":"shopify","group_platform":"shopping","partner_id":"69371002902","partner_merchant_id":null,"currency":"VND","country":"VN","name":"Abcd Bike","domain":"https://tracem2.myshopify.com","url":"https://tracem2.myshopify.com","logo":null,"description":"","expired_time":null,"refresh_expired_time":null,"config":{"map_pickup":{"167":89668026390},"map_location":{},"map_warehouse":{},"list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":true,"is_active":true,"last_refresh_token_time":1728497416.0,"last_sync_order_time":1746601201.0,"created_time":1728497416.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":338,"platform":"shopify","group_platform":"shopping","partner_id":"89138692406","partner_merchant_id":null,"currency":"VND","country":"VN","name":"xxistore.98","domain":"https://xxistore-98.myshopify.com","url":"https://tracem2.myshopify.com/","logo":null,"description":"Test","expired_time":null,"refresh_expired_time":null,"config":{"map_pickup":{"167":100368482614},"map_location":{},"map_warehouse":{},"volume_default":"20x30x10","weight_default":"500","time_to_create_shipment":1,"list_pickup_allow_push_stock":["167"]},"default_return":167,"allow_push_stock_auto":true,"allow_create_shipment_auto":true,"allow_sync_order_auto":true,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1724926388.0,"last_sync_order_time":1746601201.0,"created_time":1724926388.0,"updated_time":1746601202.0,"user":190,"business":276,"pickup_address":167,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":true,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoshopify_1739504260.png","support_map_pickup":true,"is_merchant_shop":false},{"id":337,"platform":"b2b","group_platform":"retail","partner_id":null,"partner_merchant_id":null,"currency":"VND","country":"VN","name":"Hary Trần","domain":null,"url":null,"logo":null,"description":null,"expired_time":0,"refresh_expired_time":0,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1724740357.0,"last_sync_order_time":0.0,"created_time":1724740357.0,"updated_time":1735614791.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":false,"platform_logo":"https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/b2b_1739504341.png","support_map_pickup":false,"is_merchant_shop":false},{"id":336,"platform":"retail","group_platform":"retail","partner_id":null,"partner_merchant_id":null,"currency":"VND","country":"VN","name":"Hary Trần","domain":null,"url":null,"logo":null,"description":null,"expired_time":0,"refresh_expired_time":0,"config":{},"default_return":null,"allow_push_stock_auto":false,"allow_create_shipment_auto":false,"allow_sync_order_auto":false,"allow_create_shipment_out_stock":false,"is_active":true,"last_refresh_token_time":1724740357.0,"last_sync_order_time":0.0,"created_time":1724740357.0,"updated_time":1724740357.0,"user":190,"business":276,"pickup_address":null,"parent":null,"can_refresh_token":false,"is_expired":false,"is_support_desc_html":false,"can_reconnect":false,"platform_logo":"https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png","support_map_pickup":false,"is_merchant_shop":false}],"error":false,"error_code":null,"log_id":null,"messages":"","total":16}

Request

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

Responses

🟢200Success
application/json
Body
status_code
integer 
optional
HTTP response code, e.g., 200 for a successful request.
data
array [object {34}] 
optional
List of store objects. Each store contains
id
integer 
optional
Unique store ID.
platform
string 
optional
The platform name (e.g., "shopify", "nhanh").
group_platform
string 
optional
Category of platform (e.g., "shopping").
partner_id
string 
optional
ID assigned by the third-party platform.
partner_merchant_id
string 
optional
Merchant ID from the partner platform (can be null).
currency
string 
optional
Store's currency (e.g., "VND").
country
string 
optional
Country code of the store (e.g., "VN").
name
string 
optional
Store name.
domain
string  | null 
optional
url
string  | null 
optional
logo
string  | null 
optional
Logo image URL (can be null).
description
string 
optional
Store description (optional).
expired_time
integer  | null 
optional
Token expiration times (Unix timestamp).
refresh_expired_time
string  | null 
optional
Token expiration times (Unix timestamp).
config
object 
optional
Store configuration object, may include:
default_return
integer  | null 
optional
Default pickup address ID for returns (can be null).
allow_push_stock_auto
boolean 
optional
Whether the system can automatically push stock to the platform.
allow_create_shipment_auto
boolean 
optional
Whether the system can automatically create shipments.
allow_sync_order_auto
boolean 
optional
Whether the system can auto-sync orders from the platform.
allow_create_shipment_out_stock
boolean 
optional
Whether shipments can be created even if the stock is unavailable.
is_active
boolean 
optional
Whether the store is currently active.
last_refresh_token_time
integer 
optional
Timestamps of the last token refresh and order sync.
last_sync_order_time
integer 
optional
Timestamps of the last token refresh and order sync.
created_time
integer 
optional
Timestamps for store creation and last update.
updated_time
integer 
optional
Timestamps for store creation and last update.
user
integer 
optional
ID of the user who owns the store.
business
integer 
optional
ID of the associated business.
pickup_address
integer  | null 
optional
ID of the default pickup address (can be null).
can_refresh_token
boolean 
optional
Indicates whether the token can be refreshed.
is_expired
boolean 
optional
Whether the store connection is expired.
is_support_desc_html
boolean 
optional
Indicates support for HTML in product descriptions.
can_reconnect
boolean 
optional
Whether the store can be reconnected.
platform_logo
string 
optional
Logo URL for the platform (e.g., Shopify).
support_map_pickup
boolean 
optional
Whether mapping pickup addresses is supported.
error
boolean 
optional
Indicates if an error occurred.
error_code
string  | null 
optional
Error code if applicable.
log_id
string  | null 
optional
Log ID for internal tracking.
messages
string 
optional
Optional message from the server.
total
integer 
optional
Total number of store records returned.
Previous
List vendor
Next
List category
Built with