Kho Hàng

Các API về kho hàng cho phép bạn tạo, xem, cập nhật và xóa một hay nhiều kho hàng.

Lấy Thông Tin Kho Hàng

API này cho phép bạn lấy thông tin tất cả các kho hàng hiện có.

Endpoint

get/v1/partner/warehouses

Request

Ví dụ

curl --request GET \
     --url https://api.mysupership.vn/v1/partner/warehouses \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <Access-Token>'

Response

Kết Quả Trả Về

Thuộc_Tính	Kiểu_DL	Mô_Tả_Chi_Tiết
code	String	Mã Kho Hàng. Ví dụ: W1BZE00005.
name	String	Tên Kho Hàng. Ví dụ: Kho Bàu Cát.
address	String	Địa Chỉ Kho Hàng. Ví dụ: 37 Bàu Cát 1.
formatted_address	String	Địa Chỉ Đầy Đủ của Kho Hàng. Ví dụ: 37 Bàu Cát 1, Phường 14, Quận Tân Bình, Thành phố Hồ Chí Minh.
status	String	Trạng Thái của Kho Hàng. Ví dụ: 1. Các giá trị có thể: - Đang Hoạt Động: 1. - Dừng Hoạt Động: 2.
status_name	String	Tên Trạng Thái của Kho Hàng.
primary	String	Cấu Hình Kho Mặc Định. Ví dụ: 2. Các giá trị có thể: - Kho Mặc Định: 1. - Kho Thường: 2.
primary_name	String	Tên Cấu Hình Kho Mặc Định.
created_at	String	- Thời Gian Tạo của Kho Hàng. Ví dụ: 2018-07-03T17:18:29+07:00. - Định dạng ISO 8601
updated_at	String	- Thời Gian Cập Nhật của Kho Hàng. Ví dụ: 2018-07-03T17:18:29+07:00. - Định dạng ISO 8601

Ví dụ

{
    "status": "Success",
    "results": [
        {
            "code": "WCQ1I07047",
            "name": "Kho Hoàng Nam",
            "address": "47 Huỳnh Văn Bánh",
            "formatted_address": "47 Huỳnh Văn Bánh, Phường 13, Quận Tân Bình, Thành phố Hồ Chí Minh",
            "status": "1",
            "status_name": "Hoạt Động",
            "primary": "2",
            "primary_name": "Kho Thường",
            "created_at": "2018-08-14T03:35:58+07:00",
            "updated_at": "2018-08-14T03:44:43+07:00"
        },
        {
            "code": "WLKGT07050",
            "name": "Kho Hbt",
            "address": "47 Lê Lợi",
            "formatted_address": "47 Lê Lợi, Phường Thanh Trì, Quận Hoàng Mai, Thành phố Hà Nội",
            "status": "1",
            "status_name": "Hoạt Động",
            "primary": "1",
            "primary_name": "Kho Mặc Định",
            "created_at": "2018-08-14T03:44:43+07:00",
            "updated_at": "2018-08-14T04:15:48+07:00"
        }
    ]
}

Tạo Kho Hàng

API này cho phép bạn tạo một kho hàng mới.

Endpoint

post/v1/partner/warehouses/create

Request

Các Tham Số

Thuộc_Tính	Bắt_Buộc	Kiểu_DL	Mô_Tả_Chi_Tiết
name	Có	String	Tên Kho Hàng. Ví dụ: Kho Bàu Cát.
phone	Có	String	Số Điện Thoại của Người Liên Lạc. Ví dụ: 0989999888.
contact	Có	String	Tên của Người Liên Lạc. Ví dụ: Trần Ngọc Minh.
address	Có	String	Địa Chỉ của Kho Hàng. Ví dụ: 56 Trương Công Định.
province	Có	String	Tên Tỉnh/Thành Phố của Kho Hàng. Ví dụ: Thành phố Hồ Chí Minh.
district	Có	String	Tên Quận/Huyện của Kho Hàng. Ví dụ: Quận Tân Bình.
commune	Có	String	Tên Phường/Xã của Kho Hàng. Ví dụ: Phường 14.
primary	Có	String	Cấu Hình Kho Mặc Định. Ví dụ: 2. Các giá trị có thể: - Kho Mặc Định: 1. - Kho Thường: 2.
partner	Không	String	Mã Bí Mật. Dành cho các Đối Tác Thương Mại Điện Tử lớn với SuperShip.

Ví Dụ

curl --request POST \
     --url https://api.mysupership.vn/v1/partner/warehouses/create \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <Access-Token>' \
     --header 'Content-Type: application/json' \
     --data '{
        "name": "Kho HM",
        "phone": "0989999888",
        "contact": "Trần Cao Cường",
        "address": "47 Lê Lợi",
        "province": "Thành phố Hồ Chí Minh",
        "district": "Quận Tân Bình",
        "commune": "Phường 14",
        "primary": "1"
    }'

Response

Kết Quả Trả Về

Thuộc_Tính	Kiểu_DL	Mô_Tả_Chi_Tiết
code	String	Mã Kho Hàng. Ví dụ: W1BZE00005.
name	String	Tên Kho Hàng. Ví dụ: Kho Bàu Cát.
address	String	Địa Chỉ Kho Hàng. Ví dụ: 37 Bàu Cát 1.
formatted_address	String	Địa Chỉ Đầy Đủ của Kho Hàng. Ví dụ: 37 Bàu Cát 1, Phường 14, Quận Tân Bình, Thành phố Hồ Chí Minh.
status	String	Trạng Thái của Kho Hàng. Ví dụ: 1. Các giá trị có thể: - Đang Hoạt Động: 1. - Dừng Hoạt Động: 2.
status_name	String	Tên Trạng Thái của Kho Hàng.
primary	String	Cấu Hình Kho Mặc Định. Ví dụ: 2. Các giá trị có thể: - Kho Mặc Định: 1. - Kho Thường: 2.
primary_name	String	Tên Cấu Hình Kho Mặc Định.
created_at	String	- Thời Gian Tạo. Ví dụ: 2018-07-03T17:18:29+07:00. - Định dạng ISO 8601
updated_at	String	- Thời Gian Cập Nhật. Ví dụ: 2018-08-14T03:44:43+07:00. - Định dạng ISO 8601

Ví dụ

{
    "status": "Success",
    "results": {
        "code": "WLKGT07050",
        "name": "Kho HBT",
        "address": "47 Lê Lợi",
        "formatted_adress": "47 Lê Lợi, Phường Thanh Trì, Quận Hoàng Mai, Thành phố Hà Nội",
        "status": "1",
        "status_name": "Hoạt Động",
        "primary": "1",
        "primary_name": "Kho Mặc Định",
        "created_at": "2018-08-14T03:44:43+07:00",
        "updated_at": "2018-08-14T03:44:43+07:00"
    }
}

Sửa Kho Hàng

API này cho phép bạn sửa một kho hàng hiện có.

LƯU Ý

Để thay đổi các giá trị về Địa Chỉ, Phường/Xã, Quận/Huyện, Tỉnh/Thành Phố thì hãy Tạo Kho Hàng Mới.

Endpoint

post/v1/partner/warehouses/update

Request

Các Tham Số

Thuộc_Tính	Bắt_Buộc	Kiểu_DL	Mô_Tả_Chi_Tiết
code	Có	String	Mã Kho Hàng. Ví dụ: WLKGT07050.
name	Có	String	Tên Kho Hàng. Ví dụ: Kho Bàu Cát.
phone	Có	String	Số Điện Thoại của Người Phụ Trách kho hàng. Ví dụ: 0989999888.
contact	Có	String	Tên của Người Liên Lạc. Ví dụ: Trần Ngọc Minh.

Ví Dụ

curl --request POST \
     --url https://api.mysupership.vn/v1/partner/warehouses/update \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <Access-Token>' \
     --header 'Content-Type: application/json' \
     --data '{
        "code": "WLKGT07050",
        "name": "Kho Hbt",
        "phone": "0989999888",
        "contact": "Dương Mạnh Quân"
    }'

Response

Kết Quả Trả Về

Thuộc_Tính	Kiểu_DL	Mô_Tả_Chi_Tiết
code	String	Mã Kho Hàng. Ví dụ: WLKGT07050.
diff	Object	Các trường xuất hiện trong Object này là giá trị được cập nhật thành công. Ví dụ: trường name đã được cập nhật từ `Trần Cao Cường` sang `Lê Nam Quân`.
updated_at	String	- Thời Gian Cập Nhật. Ví dụ: 2018-08-14T15:03:59+07:00. - Định dạng ISO 8601

Ví dụ

{
    "status": "Success",
    "results": {
        "code": "WLKGT07050",
        "diff": {
            "name": "Kho Ba Đình",
            "contact": "Lê Nam Quân"
        },
        "updated_at": "2018-08-14T15:03:59+07:00"
    }
}

# Kho Hàng

# Lấy Thông Tin Kho Hàng

# Endpoint

# Request

# Ví dụ

# Response

# Kết Quả Trả Về

# Ví dụ

# Tạo Kho Hàng

# Endpoint

# Request

# Các Tham Số

# Ví Dụ

# Response

# Kết Quả Trả Về

# Ví dụ

# Sửa Kho Hàng

# Endpoint

# Request

# Các Tham Số

# Ví Dụ

# Response

# Kết Quả Trả Về

# Ví dụ

Kho Hàng

Lấy Thông Tin Kho Hàng

Endpoint

Request

Ví dụ

Response

Kết Quả Trả Về

Ví dụ

Tạo Kho Hàng

Endpoint

Request

Các Tham Số

Ví Dụ

Response

Kết Quả Trả Về

Ví dụ

Sửa Kho Hàng

Endpoint

Request

Các Tham Số

Ví Dụ

Response

Kết Quả Trả Về

Ví dụ