Locations API - Danh sách địa chỉ theo loại danh sách mã địa chỉ

API thực hiện lấy danh sách địa chỉ theo danh sách mã địa chỉ

Các thông tin cấu hình cần thiết:

Tên	Mô tả
CompanyCode	Mã cửa hàng lấy
AccessToken	Chuỗi token xác thực
Environment	Sub path để gọi request tới api lấy dữ liệu

Để lấy các thông tin trên xem bài viết account/login

About

URL	Phiên bản	Thay đổi
graphapi.mshopkeeper.vn/{Environment}	1.0.0.5	init

Schemes

Scheme
https

Endpoints

api/v1/locations/byids

POST

Lấy danh sách địa danh theo loại và mã địa danh cha (nếu có).

Expected Response Types

HttpCode	ServiceResult.ErrorType	Mô tả
401		Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200	0	Không có lỗi
200	1	Tham số không hợp lệ null or empty
200	2	Mã cửa hàng không tồn tại
200	5	Tham số lấy phân trang vượt quá số lượng cấu hình cho phép (max 100)
200	7	Thiết lập kết nối MShopKeeper đang ở trạng thái ngắt, không thể lấy dữ liệu
200	100	Lỗi nội bộ API Graph
200	102	Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.

Parameters

Name	In	Description	Required?	Type
ids	body	mảng chuỗi danh sách mã địa chỉ	true	Array[string]

Headers (gửi lên theo header field)

Name	In	Description	Required?	Type
Authorization	header	Header key cấu hình AccessToken (dạng `Bearer AccessToken`)	true	string
CompanyCode	header	Header key cấu hình mã cửa hàng CompanyCode	true	string

Ví dụ:

CompanyCode: demoquanao
Authorization: Bearer 06S1YMPgDJl65xE5tYzAJlNmVALHVHlLZg9euMUaUTO9C0Jm8TL3L4isto97ApKdQbVVX2rUJUTfXbBBipo1B5UvAgl3hwDYh8bNGVVUNp6B99Ht3KZQkwVh2SNblX-vulGSNatV-NF1KOfNJImOUsVXimxVEX3n2lnRV0A_mbJ_XP0sliGqbMzwa9YtY-jts4Iu06TaFOqBpBhndS-mofDlZlKkVqYklwy6cDzBktas7Xfi5MOsCujCDYO_0WFauBQCPDVnSj6ew_3Nm5ollwynkmErSmVf2E4cShM4700

Content Types Produced

Produces
application/json

Content Types Consumed

Consumes
application/json

Response

Trả về đối tượng ServiceResult với ServiceResult.Data là Array<Location> tổng số hàng hóa có trong hệ thống qua ServiceResult.Total

Example

Ví dụ gửi tham số gọi tới api lấy về danh sách quốc địa chỉ có các mã địa chỉ:

Id	Name
VN1011303	Phường Dịch Vọng
VN10113	Quận Cầu Giấy
VN101	Hà Nội
VN	Việt Nam

thì POST dạng raw array = ['VN1011303','VN10113','VN101','VN'] tới api graphapi.mshopkeeper.vn/{Environment}/api/v1/locations/byids

Hệ thống sẽ trả về ServiceResult với Data là Array<Location> JSON response

{
  "Code": 200,
  "Data": [
    {
      "Id": "VN1011303",
      "Kind": 3,
      "Name": "Phường Dịch Vọng",
      "SortOrder": 0
    },
    {
      "Id": "VN10113",
      "Kind": 2,
      "Name": "Quận Cầu Giấy",
      "SortOrder": 0
    },
    {
      "Id": "VN101",
      "Kind": 1,
      "Name": "Hà Nội",
      "SortOrder": 0
    },
    {
      "Id": "VN",
      "Kind": 0,
      "Name": "Việt Nam",
      "SortOrder": 0
    }
  ],
  "Total": 0,
  "Success": true,
  "Environment": "g1"
}

Definitions

Location Definition

Property	Type	Mô tả
Id	string	Id địa chỉ, ví dụ: VN
Name	string	Tên địa chỉ, ví dụ: Việt Nam
Kind	LocationKind	Loại địa chỉ
SortOrder	int	Số thứ tự

ServiceResult Definition

Property	Type	Format	Mô tả
Code	int		Mã lỗi HttpCode (200, 500...)
ErrorType	int		Loại lỗi
ErrorMessage	string		Thông tin lỗi
Success	bool		True - không có lỗi logic xảy ra
Environment	string		Môi trường triển khai của api
Data	string	object	Dữ liệu trả về client
Total	int		Tổng số bản ghi khi lấy dữ liệu phân trang

LocationKind Definition

Giá trị	Mô tả
0	Lấy danh sách quốc gia
1	Lấy danh sách tỉnh/thành phố
2	Lấy danh sách quận/huyện
3	Lấy danh sách xã/phường

ErrorType Definition

Dải mã lỗi chung

HttpCode	ServiceResult.ErrorType	Mô tả
401		Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200	0	Không có lỗi
200	1	Tham số không hợp lệ null or empty
200	2	Mã cửa hàng không tồn tại
200	3	Mã Appid không tồn tại trên hệ thống
200	4	Chuỗi thông tin chữ ký đăng nhập không hợp lệ, timeout
200	5	Tham số lấy phân trang vượt quá số lượng cấu hình cho phép (max 100)
200	6	Tham số ngày giờ không hợp lệ (01/01/1753 - 31/12/9999)
200	7	Thiết lập kết nối MShopKeeper đang ở trạng thái ngắt, không thể lấy dữ liệu

Dải mã lỗi nghiêm trọng

HttpCode	ServiceResult.ErrorType	Mô tả
200	100	Lỗi nội bộ API Graph
200	102	Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại. Ví dụ: Khi đang gọi api login mà api chưa trả về dữ liệu lại tiếp tục gọi request login này sẽ trả về lỗi này.