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

API thực hiện lấy danh sách địa chỉ theo loại quốc gia, tỉnh/thành, quận/huyện, xã/phường theo loại địa chỉ và mã cha.

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/bykindandparentid?kind=`{kind}`&parentId=`{parentId}`

GET

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
kind	queryString	Loại của địa chỉ, chú ý: tên tham số có phân biệt hoa thường	true	int LocationKind
parentId	queryString	Mã địa chỉ cha, chú ý: tên tham số có phân biệt hoa thường	false	string, chuỗi id của địa chỉ cha

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

Lấy danh sách quốc gia

Ví dụ gửi tham số gọi tới api lấy về danh sách quốc gia thì truyền parentId là rỗng ""

graphapi.mshopkeeper.vn/{Environment}/api/v1/locations/bykindandparentid?kind=0&parentId=

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

{
  "Code": 200,
  "Data": [
    {
      "Id": "VN",
      "Kind": 0,
      "Name": "Việt Nam",
      "SortOrder": 0
    },
    {
      "Id": "AF",
      "Kind": 0,
      "Name": "Afghanistan",
      "SortOrder": 2
    },
    {
      "Id": "AL",
      "Kind": 0,
      "Name": "Albania",
      "SortOrder": 3
    },
    {
      "Id": "DZ",
      "Kind": 0,
      "Name": "Algeria",
      "SortOrder": 4
    },
    {
      "Id": "AS",
      "Kind": 0,
      "Name": "American Samoa",
      "SortOrder": 5
    },
    {
      "Id": "AD",
      "Kind": 0,
      "Name": "Andorra",
      "SortOrder": 6
    }
    //..more
}

Lấy danh sách tỉnh/thành phố

Lấy danh sách các tỉnh/thành phố của Việt Nam (hiện chỉ có danh sách tỉnh/thành phố của Việt Nam), truyền kind = 1, và parentId = VN là Id của Việt Nam. gọi api tới graphapi.mshopkeeper.vn/{Environment}/api/v1/locations/bykindandparentid?kind=1&parentId=VN