Đơn hàng

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

Tính Cước Phí

API này cho phép bạn tính trước cước phí của một đơn hàng.

Endpoint

get/v1/partner/orders/fee

Request

Các Tham Số

Thuộc TínhCầnLoạiMô Tả
sender_provinceStringTên Tỉnh/Thành Phố của Người Gửi. Ví dụ: Thành phố Hồ Chí Minh.
sender_districtStringTên Quận/Huyện của Người Gửi. Ví dụ: Bình Chánh.
receiver_provinceStringTên Tỉnh/Thành Phố của Người Nhận. Ví dụ: Hà Nội.
receiver_districtStringTên Quận/Huyện của Người Nhận. Ví dụ: Tây Hồ.
weightInteger- Khối lượng của Đơn Hàng. Ví dụ: 200.
- Đơn vị tính gram.
valueKhôngInteger- Trị giá của Đơn Hàng. Ví dụ: 4200000.
- Dùng để tính Phí Bảo Hiểm.
- Đơn vị tính đồng.

Ví Dụ

curl --request GET \
  --url 'https://api.mysupership.vn/v1/partner/orders/fee?sender_province=H%E1%BB%93%20Ch%C3%AD%20Minh&sender_district=B%C3%ACnh%20Ch%C3%A1nh&receiver_province=H%C3%A0%20N%E1%BB%99i&receiver_district=T%C3%A2y%20H%E1%BB%93&weight=200&value=12000000' \
  --header 'Accept: application/json'

Response

Tham Số Trả Về

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
serviceString- Tên Gói Dịch Vụ. Ví dụ: Tốc Hành.
- Có 2 loại Gói Dịch Vụ là Tốc HànhTiết Kiệm.
- Gói Tiết Kiệm chỉ áp dụng cho Đơn Hàng Nội Thành ở Thành phố Hồ Chí Minh và Thành phố Hà Nội.
feeIntegerCước Phí Giao Hàng. Ví dụ: 20000.
insuranceIntegerCước Phí Bảo Hiểm. Ví dụ: 42000.
pickupObjectThời gian dự kiến Lấy Hàng.
deliveryObjectThời gian dự kiến Giao Hàng.

Ví Dụ

{
    "status": "Success",
    "results": [
        {
            "service": "Tốc Hành",
            "fee": 35000,
            "insurance": 120000,
            "pickup": {
                "date": "03/07/2018",
                "time": "Chiều nay",
                "name": "Chiều nay - 03/07/2018"
            },
            "delivery": {
                "date": "05/07/2018",
                "time": "Sáng mốt",
                "name": "Sáng mốt - 05/07/2018"
            }
        }
    ]
}

Tạo Đơn Hàng

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

Endpoint

post/v1/partner/orders/add

Request

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
pickup_codeKhôngStringMã Kho hàng/Điểm Lấy Hàng của Người Gửi. Nếu mục này có giá trị khác rỗng thì sẽ ưu tiên lấy theo trường này.
pickup_addressStringĐịa chỉ của Điểm Lấy Hàng. Ví dụ: 45 Nguyễn Chí Thanh.
pickup_provinceStringTên Tỉnh/Thành Phố của Người Gửi. Ví dụ: Hà Nội.
pickup_districtStringTên Quận/Huyện của Người Gửi. Ví dụ: Ba Đình.
pickup_communeKhôngStringTên Phường/Xã của Người Gửi. Ví dụ: Ngọc Khánh.
nameStringTên của Người Nhận. Ví dụ: Trần Ngọc Nam.
phoneStringSố Điện Thoại của Người Nhận.
sphoneKhôngStringSố Điện Thoại thứ 2 của Người Nhận.
emailKhôngStringEmail của Người Nhận.
addressStringĐịa Chỉ của Người Nhận. Ví dụ: 56 Trương Công Định.
provinceStringTên Tỉnh/Thành Phố của Người Nhận. Ví dụ: Hồ Chí Minh.
districtStringTên Quận/Huyện của Người Nhận. Ví dụ: Tân Bình.
communeKhôngStringTên Phường/Xã của Người Nhận. Ví dụ: Phường 14.
amountIntegerSố tiền thu hộ. Ví dụ: 200000.
Đơn vị tính đồng.
valueKhôngIntegerGiá trị của đơn hàng. Ví dụ: 4200000.
Đơn vị tính đồng.
weightIntegerKhối lượng của đơn hàng. Ví dụ: 200.
Đơn vị tính gram.
socKhôngStringMã Đơn Hàng riêng của Người Gửi. Ví dụ: KR-180703-034.
noteKhôngStringGhi chú thêm về Đơn Hàng của Người Gửi. Ví dụ: Hàng dễ vỡ, lưu ý dùm shop.
serviceStringMã Gói Dịch Vụ. Ví dụ: 1.
Các giá trị có thể:
- Gói Tốc Hành: 1.
- Gói Tiết Kiệm: 2.
configStringNgười Nhận có được quyền xem/thử sản phẩm. Ví dụ: 1.
Các giá trị có thể:
- Cho Xem Hàng Nhưng Không Cho Thử Hàng: 1
- Cho Thử Hàng: 2.
- Không Cho Xem Hàng: 3
payerStringNgười Trả Phí. Ví dụ: 1.
Các giá trị có thể:
- Người Gửi: 1.
product_typeStringCách truyển sản phẩm. Ví dụ: 1.
Các giá trị có thể:
- Dạng Chuỗi: 1.
- Dạng Mảng: 2.
productKhôngStringBắt buộc khi giá trị của product_type1. Ví dụ: Quần áo.
productsKhôngArrayBắt buộc khi giá trị của product_type2.
Các tham số:
- sku: Mã Sản Phẩm. Ví dụ: P899234.
- name: Tên Sản Phẩm. Ví dụ: Áo khoác P4.
- price: Giá Sản Phẩm. Ví dụ: 200000.
- weight: Khối Lượng. Ví dụ: 200.
- quantity: Số Lượng. Ví dụ: 1.
barterKhôngStringTùy chọn Đổi/Lấy hàng về. Nếu có yêu cầu này, đơn hàng sẽ được hỗ trợ đổi hàng và trả hàng về. Ví dụ: 1.
partnerKhôngStringMã 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/orders/add \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <Access-Token>' \
  --header 'Content-Type: application/json' \
  --data '{
	"pickup_phone": "0989999999",
	"pickup_address": "45 Nguyễn Chí Thanh",
	"pickup_commune": "Ngọc Khánh",
	"pickup_district": "Ba Đình",
	"pickup_province": "Hà Nội",
	"name": "Trương Thế Ngọc",
	"phone": "0945900350",
	"email": null,
	"address": "35 Trương Định",
	"province": "Hồ Chí Minh",
	"district": "Quận 3",
	"commune": "Phường 6",
	"amount": "220000",
	"value": null,
	"weight": "200",
	"payer": "1",
	"service": "1",
	"config": "1",
	"soc": "KAN7453535",
	"note": "Giao giờ hành chính",
	"product_type": "2",
    "products": [
    	{
    		"sku": "P899234",
    		"name": "Tên Sản Phẩm 1",
    		"price": 200000,
    		"weight": 200,
    		"quantity": 1
    	},
    	{
    		"sku": "P899789",
    		"name": "Tên Sản Phẩm 2",
    		"price": 250000,
    		"weight": 300,
    		"quantity": 2
    	}
    ]
}'

Response

Các Tham Số

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng của SuperShip.
socStringMã Đơn Hàng của Người Gửi.
phoneStringSố Điện Thoại của Người Nhận.
addressStringĐịa Chỉ của Người Nhận. Ví dụ: 47 Huỳnh Văn Bánh, Phường 5, Quận Phú Nhuận, Thành phố Hồ Chí Minh.
amountIntegerSố Tiền cần Thu Hộ.
valueIntegerTrị Giá của Đơn Hàng.
weightIntegerKhối Lượng của Đơn Hàng.
feeIntegerCước Phí Giao Hàng.
statusStringMã Trạng Thái của Đơn Hàng.
status_nameStringTên Trạng Thái của Đơn Hàng.

Ví Dụ

{
  "status": "Success",
  "results": {
    "code": "S964885SGLV.0269115",
    "soc": "KAN7453535",
    "phone": "0945900350",
    "amount": "220000",
    "value": null,
    "weight": "200",
    "fee": 30000,
    "status": "2",
    "status_name": "Chờ Lấy Hàng"
  }
}

Lấy Thông Tin Đơn Hàng

API này cho phép bạn lấy thông tin chi tiết của một Đơn Hàng.

Endpoint

get/v1/partner/orders/info

Request

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng trên hệ thống SuperShip. Ví dụ: S521788SGNT.0302429.

Ví Dụ

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/orders/info?code=S521788SGNT.0302429'

Response

Các Tham Số

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng của SuperShip.
socStringMã Đơn Hàng của Người Gửi.
receiverStringThông Tin Người Nhận.
receiver.addressStringĐịa Chỉ của Người Nhận. Ví dụ: 47 Huỳnh Văn Bánh, Phường 5, Quận Phú Nhuận, Thành phố Hồ Chí Minh.
amountIntegerSố Tiền cần Thu Hộ.
valueIntegerTrị Giá của Đơn Hàng.
weightIntegerKhối Lượng của Đơn Hàng.
feeIntegerCước Phí Giao Hàng.
statusStringMã Trạng Thái của Đơn Hàng.
status_nameStringTên Trạng Thái của Đơn Hàng. Ví dụ: Đã Giao Hàng Toàn Bộ.
payerStringNgười Trả Phí.
configStringCấu Hình xem/thử hàng.
pickupObjectThời gian dự kiến Lấy Hàng.
deliveryObjectThời gian dự kiến Giao Hàng.
journeysObjectThông tin hành trình của Đơn Hàng.
created_atStringThời Gian Tạo của Đơn Hàng.
updated_atStringThời Gian Cập Nhật của Đơn Hàng.

Ví Dụ

{
    "status": "Success",
    "results": {
        "code": "S521788SGNT.0302429",
        "soc": null,
        "status": "Chờ Lấy Hàng",
        "receiver": {
            "name": "Chị Cúc",
            "phone": "090****515",
            "address": "018 Lô K, Chung Cư Ngô Gia Tự",
            "formatted_address": "018 Lô K, Chung Cư Ngô Gia Tự, Phường 02, Quận 10, Thành phố Hồ Chí Minh"
        },
        "amount": 450000,
        "value": 0,
        "weight": 250,
        "payer": "Người Gửi",
        "config": "Cho Xem Hàng Nhưng Không Cho Thử",
        "pickup": {
            "shift": "Sáng",
            "date": "2018-07-04"
        },
        "delivery": {
            "shift": "Chiều",
            "date": "2018-07-04"
        },
        "journeys": [
            {
                "time": "2018-07-03T17:18:29+07:00",
                "status": "Chờ Duyệt",
                "province": "Thành phố Hồ Chí Minh",
                "district": "Quận 11",
                "note": "Tạo Đơn hàng"
            },
            {
                "time": "2018-07-03T17:18:29+07:00",
                "status": "Chờ Lấy Hàng",
                "province": "Thành phố Hồ Chí Minh",
                "district": "Quận 11",
                "note": "Duyệt Đơn hàng"
            }
        ],
        "created_at": "2018-07-03T17:18:29+07:00",
        "updated_at": "2018-07-03T17:18:29+07:00"
    }
}

In Đơn Hàng

API này cho phép bạn in Nhãn Giao Hàng của một Đơn Hàng trực tiếp trên trình duyệt.

Endpoint

get/v1/partner/orders/print

Request

Các tham số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng trên hệ thống SuperShip. Ví dụ: S693754SGNT.0341229.

Ví Dụ

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/orders/print?code=S693754SGNT.0341229'

Response

Ví Dụ

Hủy Đơn Hàng

API này cho phép bạn hủy một Đơn Hàng.

Endpoint

post/v1/partner/orders/cancel

Request

Các tham số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng của SuperShip. Ví dụ: S521788SGNT.0302429.

Ví Dụ

curl --request POST \
     --url https://api.mysupership.vn/v1/partner/orders/cancel \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <Access-Token>' \
     --header 'Content-Type: application/json' \
     --data '{
        "code": "S521788SGNT.0302429"
     }'

Response

Các Tham Số

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng của SuperShip.
socStringMã Đơn Hàng của Người Gửi.
addressStringĐịa Chỉ của Người Nhận. Ví dụ: 47 Huỳnh Văn Bánh, Phường 5, Quận Phú Nhuận, Thành phố Hồ Chí Minh.
statusStringMã Trạng Thái của Đơn Hàng.
status_nameStringTên Trạng Thái của Đơn Hàng.

Ví Dụ

{
    "status": "Success",
    "results": {
        "code": "S521788SGNT.0302429",
        "soc": "KR-180703-034",
        "address": "47 Huỳnh Văn Bánh, Phường 5, Quận Phú Nhuận, Thành phố Hồ Chí Minh",
        "status": "0",
        "status_name": "Hủy",
    }
}
Cập Nhật Lần Cuối: 2018-9-19 11:52:33