Shipping Carrier Object Schema

Mỗi Shipping Carrier là một tài khoản hãng vận chuyển mà shop tự kết nối vào Hubport (mô hình "shop dùng tài khoản hãng của mình"). Hubport dùng thông tin kết nối này để báo giá, tạo vận đơn, in nhãn, huỷ và tra cứu hành trình tại hãng.

JSON SchemaCopy Anchor Link

Giá trị api_typeCopy Anchor Link

Dùng GET /v1/shippingcarriers/apitypes để biết hãng nào đang cho tạo mới (creatable).

Các trường api_setting theo hãngCopy Anchor Link

Khi tạo / sửa carrier, shop gửi api_setting là object với các trường sau (trường không có trong danh sách sẽ bị bỏ khi lưu). Mọi hãng đều có is_sandbox (int, 1 = gọi môi trường thử nghiệm của hãng).

GHN (api_type = 19)Copy Anchor Link

ViettelPost (api_type = 15)Copy Anchor Link

GHTK (api_type = 7)Copy Anchor Link

J&T Express (api_type = 9)Copy Anchor Link

BeDelivery (api_type = 13)Copy Anchor Link

Ahamove (api_type = 17)Copy Anchor Link

Bảo mật thông tin kết nốiCopy Anchor Link

• Các trường đánh dấu Bí mật là chỉ ghi: API không bao giờ trả lại giá trị thật. Trong response, trường bí mật đã có giá trị trả về "********", chưa có thì trả "".
• Khi sửa carrier (cùng api_type), gửi trường bí mật là "" hoặc "********" thì Hubport giữ nguyên giá trị đang lưu. Chỉ gửi giá trị mới khi muốn thay.
• Đổi carrier sang api_type khác thì thông tin kết nối cũ không được giữ.

Ví dụ JSONCopy Anchor Link

{
  "company_id": 1001,
  "creator_id": 5,
  "id": 12,
  "name": "GHN - Kho Hà Nội",
  "description": "",
  "status": 1,
  "display_order": 1,
  "api_type": 19,
  "date_created": 1760000000,
  "date_modified": 1760003600,
  "api_setting": {
    "issandbox": 0,
    "connect_mode": "token",
    "token": "********",
    "shop_id": 885123,
    "webhook_token": "",
    "service_type_id": 0,
    "payment_type_id": 1,
    "required_note": "KHONGCHOXEMHANG",
    "sender_name": "Shop Demo",
    "sender_phone": "0900000000",
    "sender_address": "12 Phố Huế",
    "sender_province": 1,
    "sender_district": 7,
    "sender_ward": 0
  }
}