PosApp Open APIs
  1. Đăng ký tài khoản PosApp
PosApp Open APIs
  • Tổng quan
  • Thẻ PosApp
    • Mã lỗi (error code)
    • API Idempotency
    • Nạp tiền vào thẻ
      POST
    • Kiểm tra trạng thái giao dịch
      POST
  • Thông tin khác
    • Digital Signature
  • Webhook
    • Tổng quan
    • Order Schema
    • Warehouse Import Schema
  • Sản phẩm
    • Tạo mới sản phẩm
      POST
    • Sửa một sản phẩm
      PATCH
    • Tồn kho sản phẩm
      POST
    • Cập nhật tên nhóm sản phẩm
      PATCH
  • Khuyến mãi
    • Đồng giá
      • Tạo khuyến mãi
      • Sửa khuyến mãi
    • Xóa khuyến mãi
      POST
  • Đăng ký tài khoản PosApp
    • Danh sách mô hình kinh doanh
      GET
    • Đăng ký tài khoản
      POST
    • Kiểm tra tài khoản PosApp
      GET
  • Báo cáo
  1. Đăng ký tài khoản PosApp

Kiểm tra tài khoản PosApp

Testing
Test Env
https://retail-api.posapp.vn/
Test Env
https://retail-api.posapp.vn/
GET
api/public/shop/information
Lưu ý:
Đối tác cần liên hệ để PosApp cung cấp api-key để sử dụng trong header X-Api-Key
Rate limit: 5 request/minutes

Request

Query Params
phone
string 
optional
Số điện thoại (ưu tiên)
Example:
+84123456678
email
string 
optional
Email (sẽ kiểm tra với email nếu không có số điện thoại)
Header Params
X-Api-Key
string 
required
Example:
2|qAgM8AcNaX7fSM6OpxkgfdAKF87isB
Content-Type
string 
required
Example:
application/json

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://retail-api.posapp.vn/api/public/shop/information?phone=+84123456678&email' \
--header 'X-Api-Key: 2|qAgM8AcNaX7fSM6OpxkgfdAKF87isB' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success
application/json
Body
name
string 
required
Tên cửa hàng
phone
string 
required
Số điện thoại
email
string 
required
Email
region_name
string 
required
Tỉnh/Thành phố
town_name
string 
required
Quận/Huyện cũ hoặc Xã/Phường mới
address
string 
required
Địa chỉ cụ thể
created_at
string 
required
Ngày tạo
expired_at
string 
required
Thời gian hết hạn
package
object 
required
id
integer 
required
ID gói phần mềm đang dùng
name
string 
required
Tên gói phần mềm đang dùng
mpos_integration
object 
required
Thông tin Mpos khách đã tích hợp
integrated
boolean 
required
Đã tích hợp Mpos hay chưa
data
array [object {4}] 
required
e_invoices
array [object {2}] 
required
Hóa đơn điện tử khách đã tích hợp
id
string 
required
ID
name
string 
required
Tên đơn vị HDDT
Example
{
    "name": "DE Shop",
    "phone": "0123456678",
    "email": "hp@gmail.com",
    "region_name": "TP Hồ Chí Minh",
    "town_name": "Tân Bình",
    "address": "15 Nguyễn Trọng Tuyển P.15 Q.Phú Nhuận",
    "created_at": "2023-08-09 15:44:45",
    "expired_at": "2041-05-16 23:59:59",
    "package": {
        "id": 4,
        "name": "Gói nâng cao"
    },
    "mpos_integration": {
        "integrated": true,
        "data": [
            {
                "wallet_name": "MPos 1.0",
                "email": "",
                "phone": "",
                "merchant_id": ""
            }
        ]
    },
    "e_invoices": []
}
Modified at 2025-07-11 08:08:33
Previous
Đăng ký tài khoản
Built with