ShippingPartner API - Danh sách đối tác giao vận có kết nối
API thực hiện lấy danh sách đối tác giao vận có kết nối
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
Schemes
Endpoints
api/v1/shipping/shipping-partner-all
POST
Lấy danh sách đối tác giao vận có kết nối.
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 |
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 |
| param |
body |
mảng chuỗi danh sách mã địa chỉ |
true |
RequestParam |
| 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<ShippingPartner>
Example
Ví dụ gửi tham số gọi tới api lấy về danh sách đối tác giao vận có kết nối:
| BranchID |
| F63C29AF-F96F-476F-884F-78076A32C19C |
thì POST dạng json {"BranchID":"F63C29AF-F96F-476F-884F-78076A32C19C"} tới api
graphapi.mshopkeeper.vn/{Environment}/api/v1/shipping/shipping-partner-all
Hệ thống sẽ trả về ServiceResult với Data là Array<ShippingPartner>
JSON response
{
"Code": 200,
"Data": [
{
"PartnerID": "736d4ec9-70ab-4032-a438-6249de8a7af7",
"PartnerCode": "DTGH000002",
"Partner": "GHTK",
"PartnerName": "Giao hàng tiết kiệm"
},
{
"PartnerID": "a6cb59f7-e3cf-413a-9ee7-66c2e7af75aa",
"PartnerCode": "DTGH000001",
"Partner": "GHN",
"PartnerName": "GHN"
}
],
"Total": 0,
"Success": true,
"Environment": "g1"
}
Definitions
Shipping Partner Definition
| Property |
Type |
Format |
Mô tả |
| PartnerID |
Guid |
|
Id đối tác giao hàng |
| PartnerCode |
string |
|
Mã đối tác |
| Partner |
string |
|
Mã đối tác giao vận dùng để truyền lên API tính phí |
| PartnerName |
string |
|
Tên đối tác giao hàng |
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 |
RequestParam
| Property |
Type |
Format |
Mô tả |
| BranchID |
Guid |
|
ID chi nhánh nhận đơn |
ErrorType Definition
| 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 |
| 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. |