CONNECT CARRIER TUTORIAL

Method

URL

GET

https://apis.haravan.com/com/carrier_services.json

STT

Thuộc tính

Mô tả

1

access_token (string)

Lấy được khi cài ứng dụng và get access_token

Status

Response

200

422

{"error": "Unprocessable Entity"}

401

Unauthorized

429

Too many requests

500

Something went wrong. Please try again later.

Method

URL

GET

https://apis.haravan.com/com/carrier_services/#{id}.json

STT

Thuộc tính

Mô tả

1

id

Tham số carrier_service_id nhận được từ API lấy danh sách nhà vận chuyển

2

access_token (string)

Lấy được khi cài ứng dụng và get access_token

Status

Response

200

422

{"error": "Unprocessable Entity"}

401

Unauthorized

429

Too many requests

500

Something went wrong. Please try again later.

Method

URL

POST

https://apis.haravan.com/com/carrier_services.json

Status

Response

200

422

{"error": "Unprocessable Entity"}

401

Unauthorized

429

Too many requests

500

Something went wrong. Please try again later.

Method

URL

PUT

https://apis.haravan.com/com/carrier_services/#{id}.json

Status

Response

200

422

{"error": "Unprocessable Entity"}

401

Unauthorized

429

Too many requests

500

Something went wrong. Please try again later.

Method

URL

DELETE

https://apis.haravan.com/com/carrier_services/#{id}.json

STT

Thuộc tính

Mô tả

1

id

Tham số carrier_service_id nhận được từ API lấy danh sách nhà vận chuyển

2

access_token (string)

Lấy được khi cài ứng dụng và get access_token

Status

Response

200

[]

422

{"error": "Unprocessable Entity"}

401

Unauthorized

429

Too many requests

500

Something went wrong. Please try again later.

STT

Thuộc tính

Require

Maxlength

Mô tả

1

id (number)

20

id nhà vận chuyển

2

carrier_service_id (number)

20

Mã nhà vận chuyển

3

carrier_name (string)

200

Tên nhà vận chuyển

4

carrier_code (string)

255

Mã nhà vận chuyển

5

is_connected (bool)

Trạng thái kết nối:

+ true: đã kết nối

+ false: chưa kết nối

6

view_before_items (bool)

Cho xem trước

7

view_dimension (bool)

Cấu hình kích thước

8

view_coupon_code (bool)

Cấu hình mã khuyến mãi

9

view_sender_name (bool)

Hiện tên người gửi

10

view_sender_phone (bool)

Hiện số điện thoại người gửi

11

view_insurance (bool)

Có bảo hiểm

12

view_drop_off (bool)

Cho phép gửi hàng tại điểm

13

transport_types (array)

Hình thức vận chuyển

STT

Thuộc tính

Require

Maxlength

Mô tả

1

active (bool)

true

Có được hiển thị hay không

2

tracking_url (string)

true

500

Link xem chi tiết vận đơn

3

create_order_url (string)

true

500

Link tạo vận đơn

4

get_order_detail_url (string)

true

500

Link lấy chi tiết vận đơn

5

get_shipping_rate_url (string)

true

500

Link lấy danh sách gói vận chuyển

6

cancel_order_url (string)

true

500

Link hủy vận đơn

7

get_by_external_code_url (string)

true

500

Link lấy chi tiết vận đơn theo external_code

8

name (string)

true

200

Tên nhà vận chuyển

9

carrier_service_type (string)

true

255

Loại nhà vận chuyển

(default là api, không sửa được)

10

service_discovery (bool)

false

Có cho truyền dữ liệu để test API nhà vận chuyển hay không ( tạm thời lưu db chứ chưa dùng đến). Truyền vào: false

11

options (object)

false

Cấu hình vận chuyển

11.1

has_drop_off (bool)

false

Cho phép gởi hàng tại điểm

11.2

has_insurance (bool)

false

Có bảo hiểm

11.3

has_view_before(bool)

false

Cho xem trước

11.4

has_payment_method (bool)

false

Cấu hình phương thức thanh toán

11.5

has_dimension (bool)

false

Cấu hình kích thước

11.6

has_transport_type (bool)

false

Cấu hình phương thức vận chuyển

11.7

has_use_coupon_code (bool)

false

Cấu hình mã khuyến mãi

STT

Thuộc tính

Require

Maxlength

Mô tả

1

shop_id (string)

20

Id shop tạo vận đơn

2

origin (object)

Nơi chuyển

2.1

country (string)

200

Quốc gia

2.2

country_code (string)

5

Mã quốc gia

2.3

country_name (string)

200

Tên quốc gia

2.4

province (string)

200

Tên tỉnh thành

2.5

province_code (string)

5

Mã Tỉnh/Thành

2.6

district (string)

200

Tên Quận/Huyện

2.7

district_code (string)

5

Mã Quận/Huyện

2.8

ward (string)

200

Tên Phường/Xã

2.9

ward_code (string)

100

Mã Phường/Xã

2.10

address1(string)

1000

Địa chỉ 1

2.11

address2 (string)

1000

Địa chỉ 2

2.12

zip (string)

100

Zip

2.13

city (String)

200

Thành phố

2.14

phone (string)

12

Số điện thoại

2.15

name (string)

200

Tên

3

destination (object)

Nơi nhận (Ý nghĩa các field trong destination tương tự như origin.)

4

items (array)

List sản phẩm cần vận chuyển

4.1

name (string)

200

Tên sản phẩm

4.2

sku (string)

100

Mã SKU

4.3

quantity (int)

11

Số lượng

4.4

grams (decimal)

Giá

Trọng lượng trên sản phẩm

4.5

price (decimal)

18

Giá

4.6

product_id (long)

18

Mã sản phẩm

4.7

variant_id (long)

20

Mã biến thể của sản phẩm

5

cod_amount (decimal)

18

Số tiền thu hộ COD

6

total_grams (decimal)

18

Tổng khối lượng các item

7

external_order_id (long)

20

Order id của shop

8

external_fulfillment_id (long)

20

Mã vận chuyển

9

external_store_id (long)

20

Mã shop

10

external_code (string)

70

= external_store_id + ”_” + external_order_id + “_” + external_fulfillment_id

11

note (string)

255

Ghi chú

12

shipping_rate_id (int)

11

Là service_id nhận được khi post lấy danh sách gói vận chuyển

STT

Thuộc tính

Require

Maxlength

Mô tả

1

error (bool)

true

Status báo lỗi

2

message (string)

true

500

Thông báo

3

Data (object)

true

Dữ liệu trả về

3.1

Rates (array)

true

Danh sách gói vận chuyển

3.1.1

service_id (int)

true

11

Id gói vận chuyển

3.1.2

service_name (string)

true

200

Tên gói vận chuyển

3.1.3

service_code (string)

true

255

Mã gói vận chuyển

3.1.4

currency (string)

true

255

Loại tiền tệ

Default VNĐ

3.1.5

total_price (decimal)

true

18

Tổng tiền

3.1.6

phone_required (bool)

true

Có bắt buộc truyền số điện thoại không

3.1.7

min_delivery_date (datetime)

false

ISOString

Thời gian vận chuyển nhanh nhất Có thể null

3.1.8

Max_delivery_date (datetime)

false

ISOString

Thời gian vận chuyển chậm nhất Có thể null

3.1.9

description (string)

false

500

Miêu tả

STT

Thuộc tính

Require

Maxlength

Mô tả

1

error (bool)

true

Status lỗi

2

message (string)

true

500

Thông báo lỗi

3

data (object)

true

Dữ liệu trả

3.1

tracking_number (string)

true

200

Mã vận đơn

3.2

shipping_fee (decimal)

true

18

Phí vận chuyển

3.3

tracking_url (string)

true

400

Link xem chi tiết vận đơn

3.4

cod_amount (decimal)

true

18

Số tiền thu hộ COD

3.5

status (string)

true

18

Trạng thái vận đơn:

+ Pending: Chờ xử lý,

+ ReadyToPick: Chờ lấy hàng,

+ Picking: Đang đi lấy,

+ Delivering: Đang giao hàng,

+ Delivered: Đã giao hàng,

+ Cancel: Hủy giao hàng,

+ Return: Chuyển hoàn,

+ NotMeetCustomer: Không gặp khách,

+ WaitingForReturn: Chờ chuyển hoàn

3.6

cod_status (string)

true

16

Trạng thái thu hộ COD:

+ None: Không thu hộ,

+ CODPending: Chờ xử lý,

+ CODPaid: Đã thu hộ,

+ CODReceipt: Đã nhận tiền,

+ CODNotReceipt: Chưa nhận tiền

STT

Thuộc tính

Require

Maxlength

Mô tả

1

created_at (dateTime)

ISOString

Ngày tạo

2

id (long)

20

Id giao hàng

3

order_id (long)

20

Id đơn hàng được giao

4

Receipt (string)

5

Status (string)

Trạng thái giao hàng chờ xử lý pending, đang xử lý cancel, xử lý lỗi error, thành công

6

tracking_company (string)

18

Tên công ty vận chuyển.

+ "Giao Hàng Nhanh"

+ "VNPost"

+ "Khác"

+ "Viettel Post"

+ "ShipChung.vn"

+ "ProShip.vn"

+ "FlexShip"

+ "Giao hàng nhanh"

+ "DHL"

+ "Ninja Van"

+ "GrabExpress"

+ "AhaMove"

+ "ViettelPost2018"

+ "HCMPost2019"

7

tracking_company_code (string)

18

Mã NVC.

+ "ghn": Giao Hàng Nhanh

+ "vnpost": VNPost

+ "other": Khác

+ "viettelpost": Viettel Post

+ "shipchung": ShipChung.vn

+ "proship": ProShip.vn

+ "flexship": FlexShip

+ "ghn2018": Giao hàng nhanh

+ "dhl": DHL

+ "ninjavan": Ninja Van

+ "grabexpress": GrabExpress

+ "ahamove": AhaMove

+ "viettelpost2018": ViettelPost2018

+ "hcmpost2019": HCMPost2019

8

tracking_numbers (array)

Danh sách các mã theo dõi. Được cung cấp bởi công ty vận chuyển.

9

tracking_number (string)

200

Mã theo dõi

10

tracking_url (string)

400

Link tìm kiếm bản đồ vận chuyển

11

tracking_urls(array)

List link tìm kiếm bản đồ vận chuyển

12

updated_at (long)

20 chữ số

Thời điểm cập nhật vận chuyển

13

province (string)

200

Tỉnh thành

14

province_code (string)

5

Mã tỉnh thành

15

district (string)

200

Quận/Huyện

16

district_code (string)

5

Mã Quận/Huyện

17

ward (string)

100

Phường/Xã

18

ward_code (string)

100

Mã Phường/Xã

19

cod_amount (number)

20

Tiền thu hộ

20

carrier_status_name (string)

18

Tên và mã trạng thái vận chuyển

+ readytopick : Chờ lấy hàng

+ picking : Đang đi lấy

+ delivering : Đang giao hàng

+ delivered : Đã giao hàng

+ cancel : Hủy giao hàng

+ return : Chuyển hoàn

+ pending : Chờ xử lý

+ notmeetcustomer: Không gặp khách

+ waitingforreturn: Chờ chuyển hoàn

21

carrier_status_code (string)

18

22

carrier_cod_status_name (string)

11

Tên và mã trạng thái cod

+ none: Không

+ codpending: Chưa nhận

+ codpaid: Chưa nhận (chủ shop chưa nhận)

+ codreceipt: Đã nhận

23

carrier_cod_status_code (string)

11

24

location_id (number)

20

Mã chi nhánh lấy hàng

25

note (string)

255

Ghi chú

26

carrier_service_package (number)

20

Gói vận chuyển

27

carrier_service_package_name (string)

255

Tên gói vận chuyển

28

is_new_service_package (bool)

true/false

Nếu sử dụng gói mặc định

=> False, ngược lại là True

29

coupon_code (string)

100

Mã khuyễn mãi

30

ready_to_pick_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Sẵn sàng giao”

31

picking_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Chọn giao hàng”

32

delivering_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Đang giao hàng”

33

delivered_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Đã giao hàng”

34

return_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Trả hàng”

35

not_meet_customer_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Không gặp khách hàng”

36

waiting_for_return_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Chờ chuyển hoàn”

37

cod_paid_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Chờ nhận tiền thu hộ COD”

38

cod_receipt_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Đối soát tiền thu hộ COD”

39

cod_pending_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Đợi thu hộ COD”

40

cod_not_receipt_date (dateTime)

ISOString

Thời điểm chuyển qua trạng thái “Không đối soát tiền thu hộ COD”

41

is_view_before (bool)

true/false

Được xem hàng trước

42

country (string)

200

Quốc gia

43

country_code (string)

5

Mã quốc gia

44

zip_code (string)

5

Mã zip code quốc gia

45

city (string)

200

Thành phố

46

real_shipping_fee (number)

20

Phí vận chuyển thực

47

shipping_notes (string)

200

Ghi chú vận chuyển

48

total_weight (number)

20

Tổng khối lượng

49

package_length (number)

20

Chiều dài gói hàng

50

package_width (number)

20

Chiều rộng gói hàng

51

package_height (number)

20

Chiều cao gói hàng

52

boxme_servicecode (string)

100

Gói giao hàng của Shipchung.vn (chỉ sử dụng khi giao bằng Shipchung.vn)

53

transport_type (number)

1

Phương thức vận chuyển

+ 1: đường bộ (default)

+ 2: đường bay

54

address (string)

1000

Địa chỉ giao hàng

55

sender_phone (string)

12

SĐT người gửi

56

sender_name (string)

200

Tên người gửi

57

carrier_service_code (number)

20

Mã NVC

58

line_items (array)

List sản phẩm được vận chuyển

58.1

fulfillable_quantity

11

Số lượng sản phẩm giao hàng

58.2

fulfillment_service (string)

11

Dịch vụ giao hàng: “Thủ công”

58.3

fulfillment_status (string)

16

Trạng thái giao hàng:

+ null: Không giao hàng

+ not_fulfilled: Chưa hoàn thành

+ partial: Hoàn thành một phần

+ fulfilled: Đã hoàn thành

58.4

grams (number)

20

Khối lượng của sản phẩm

58.5

id (string)

20

Id Line Item

58.6

price (number)

20

Giá của sản phẩm trong line item

58.7

product_id (string)

20

Id sản phẩm

58.8

quantity (number)

20

Số lượng sản phẩm

58.9

requires_shipping (bool)

True: Có giao hàng

False: Không giao hàng

58.10

sku (string)

100

Mã SKU của sản phẩm

58.11

title (string)

255

Tên của sản phẩm

58.12

variant_id (string)

20

Id biến thể của sản phẩm

58.13

variant_title (string)

200

Tên biến thể của sản phẩm

58.14

vendor (string)

200

Nhà sản xuất của sản phẩm

58.15

name (string)

200

Tên sản phẩm và tên biến thể của sản phẩm

58.16

variant_inventory_management

200

Quản lý tồn kho biến thể của sản phẩm

58.17

properties(string)

200

Thuộc tính của sản phẩm

58.18

product_exists (bool)

True: Còn sản phẩm

False: Hết sản phẩm