Đơ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/price

Request

Headers

KeyValue
Acceptapplication/json
AuthorizationBearer Access-Token

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
sender_provinceStringTên Tỉnh/Thành Phố của Người Gửi. Ví dụ: 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/price?sender_province=Hồ Chí Minh&sender_district=Bình Chánh&receiver_province=Hà Nội&receiver_district=Tây Hồ&weight=200&value=12000000' \
  --header 'Accept: application/json'
  --header 'Authorization: Bearer <Access-Token>' \

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ác giá trị có thể:
- Tốc Hành.
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": {
                "name": "Chiều nay - 03/07/2018"
            },
            "delivery": {
                "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

Headers

KeyValue
Acceptapplication/json
AuthorizationBearer Access-Token
Content-Typeapplication/json

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_phoneStringSố Điện Thoại của Điểm Lấy Hàng, sMan của SuperShip sẽ liên hệ số này khi lấy hàng, giao hàng, trả hàng. Ví dụ: 0989999999.
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_communeStringTên Phường/Xã của Người Gửi. Ví dụ: Ngọc Khánh.
pickup_nameKhôngStringTên Kho Hàng/Điểm Lấy Hàng. Ví dụ: Kho Tân Bình.
pickup_contactKhôngStringTên người liên hệ Lấy Hàng. Ví dụ: Hoàng Mạnh Nam.
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.
communeStringTê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.
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"
  }
}

Trạng Thái Đơn Hàng

API này cho phép bạn lấy thông tin danh sách các trạng thái đơn hàng hiện có tại SuperShip.

Endpoint

get/v1/partner/orders/status

Request

Ví Dụ

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/orders/status'

Response

Các Tham Số

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
keyStringMã Trạng Thái Đơn Hàng.
valueStringTên Trạng Thái Đơn Hàng.

Ví Dụ

{
    "status": "Success",
    "results": [
        {
            "key": "1",
            "value": "Chờ Duyệt"
        },
        {
            "key": "2",
            "value": "Chờ Lấy Hàng"
        },
        {
            "key": "3",
            "value": "Đang Lấy Hàng"
        },
        {
            "key": "4",
            "value": "Đã Lấy Hàng"
        },
        {
            "key": "5",
            "value": "Hoãn Lấy Hàng"
        },
        {
            "key": "6",
            "value": "Không Lấy Được"
        },
        {
            "key": "7",
            "value": "Đang Nhập Kho"
        },
        {
            "key": "8",
            "value": "Đã Nhập Kho"
        },
        {
            "key": "9",
            "value": "Đang Chuyển Kho Giao"
        },
        {
            "key": "10",
            "value": "Đã Chuyển Kho Giao"
        },
        {
            "key": "11",
            "value": "Đang Giao Hàng"
        },
        {
            "key": "12",
            "value": "Đã Giao Hàng Toàn Bộ"
        },
        {
            "key": "13",
            "value": "Đã Giao Hàng Một Phần"
        },
        {
            "key": "14",
            "value": "Hoãn Giao Hàng"
        },
        {
            "key": "15",
            "value": "Không Giao Được"
        },
        {
            "key": "16",
            "value": "Đã Đối Soát Giao Hàng"
        },
        {
            "key": "17",
            "value": "Đã Đối Soát Trả Hàng"
        },
        {
            "key": "18",
            "value": "Đang Chuyển Kho Trả"
        },
        {
            "key": "19",
            "value": "Đã Chuyển Kho Trả"
        },
        {
            "key": "20",
            "value": "Đang Trả Hàng"
        },
        {
            "key": "21",
            "value": "Đã Trả Hàng"
        },
        {
            "key": "22",
            "value": "Hoãn Trả Hàng"
        },
        {
            "key": "0",
            "value": "Huỷ"
        },
        {
            "key": "23",
            "value": "Đang Vận Chuyển"
        },
        {
            "key": "24",
            "value": "Xác Nhận Hoàn"
        }
    ]
}

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

Headers

KeyValue
Acceptapplication/json
AuthorizationBearer Access-Token

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
codeStringMã Đơn Hàng. Ví dụ: SGNS983262NT.595050186.
typeKhôngStringLoại của Mã Đơn Hàng. Giá trị mặc định: 1.
Các giá trị có thể:
- Mã Đơn Hàng của SuperShip: 1
- Mã Đơn Hàng của Người Gửi: 2.

Ví Dụ

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/orders/info?code=SGNS983262NT.595050186&type=1' \
     --header 'Accept: application/json'
     --header 'Authorization: Bearer <Access-Token>' \

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.
statusStringMã Trạng Thái của Đơn Hàng. Ví dụ: 12.
status_nameStringTên Trạng Thái của Đơn Hàng. Ví dụ: Đã Giao Hàng Toàn Bộ.
receiverObjectThông Tin Người Nhận.
amountIntegerSố Tiền Thu Người Nhận.
valueIntegerTrị Giá Thực Tế của Đơn Hàng.
weightIntegerKhối Lượng của Đơn Hàng.
feeObjectCác loại Cước Phí của Đơn Hàng.
payerStringNgười Trả Phí.
configStringCấu Hình xem/thử hàng.
journeysObjectThông tin hành trình của Đơn Hàng.
notesObjectCác ghi chú của SuperShip.
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": "SGNS983262NT.595050186",
        "soc": "2102040725580332",
        "status": "0",
        "status_name": "Huỷ",
        "receiver": {
            "name": "Chị Định (Đk)",
            "phone": "098****294",
            "address": "187/9 Mai Xuân Thưởng",
            "formatted_address": "187/9 Mai Xuân Thưởng, Phường 14, Quận 6, Thành phố Hồ Chí Minh"
        },
        "fee": {
            "shipment": 16000,
            "insurance": 0,
            "return": 0,
            "barter": 0,
            "address": 0
        },
        "payer": "Người Gửi",
        "amount": 418000,
        "value": 418000,
        "weight": 300,
        "config": "Không Cho Xem Hàng",
        "journeys": [
            {
                "time": "2021-02-04T07:25:19+07:00",
                "status": "Chờ Duyệt",
                "province": "Thành phố Hồ Chí Minh",
                "district": "Quận Tân Bình",
                "note": "Tạo Đơn hàng"
            },
            {
                "time": "2021-02-04T07:25:19+07:00",
                "status": "Chờ Lấy Hàng",
                "province": "Thành phố Hồ Chí Minh",
                "district": "Quận Tân Bình",
                "note": "Duyệt Đơn hàng"
            },
            {
                "time": "2021-02-04T08:41:17+07:00",
                "status": "Huỷ",
                "province": "Thành phố Hồ Chí Minh",
                "district": "Quận Tân Bình",
                "note": "Hủy Đơn hàng"
            }
        ],
        "notes": [
            {
                "created_at": "2021-02-04T07:25:19+07:00",
                "type": "5",
                "note": "Trường Phường/Xã có thể chưa được chính xác."
            }
        ],
        "calllogs": [],
        "last_sman": null,
        "created_at": "2021-02-04T07:25:19+07:00",
        "updated_at": "2021-02-04T08:41:17+07:00"
    }
}

Tạo Token In Nhãn Giao Hàng

API này cho phép bạn lấy Token dành cho việc in Nhãn Giao Hàng.

Endpoint

post/v1/partner/orders/token

Request

Headers

KeyValue
Acceptapplication/json
AuthorizationBearer Access-Token
Content-Typeapplication/json

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
codeArrayMảng chứa danh sách Mã Đơn Hàng của SuperShip.

Ví dụ

curl --location --request POST 'https://api.mysupership.vn/v1/partner/orders/token' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <Access-Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": [
        "SGNS983262NT.593593647",
        "TGGS983262NM.613593645"
    ]
}'

Response

Các Tham Số

Thuộc_TínhKiểu_DLMô_Tả_Chi_Tiết
tokenStringToken dành cho mục đích In Nhãn Đơn Hàng.
Ví dụ: 6cf2ce20-80e9-11eb-8974-cd483a610abd.

Ví Dụ

{
    "status": "Success",
    "results": {
        "token": "6cf2ce20-80e9-11eb-8974-cd483a610abd"
    }
}

In Đơn Hàng

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

Endpoint

get/v1/partner/orders/label

Request

Các Tham Số

Thuộc_TínhBắt_BuộcKiểu_DLMô_Tả_Chi_Tiết
tokenStringToken dành cho mục đích In Đơn Hàng.
Ví dụ: 6cf2ce20-80e9-11eb-8974-cd483a610abd.
sizeStringKích thước Nhãn In Đơn Hàng.
Các giá trị có thể:
- Size A5: A5
- Size T2: T2
- Size K50: K50
- Size K75: K75
- Size K80: K80

Ví Dụ

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/orders/label?token=6cf2ce20-80e9-11eb-8974-cd483a610abd&size=A5'

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

Headers

KeyValue
Acceptapplication/json
AuthorizationBearer Access-Token
Content-Typeapplication/json

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ụ: SGNS983262NT.595050186.

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": "SGNS983262NT.595050186"
     }'

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.
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": "SGNS983262NT.595050186",
        "soc": "2102040725580332",
        "address": "187/9 Mai Xuân Thưởng, Phường 14, Quận 6, Thành phố Hồ Chí Minh",
        "status": "0",
        "status_name": "Hủy",
    }
}
Cập Nhật Lần Cuối: 3/9/2021, 8:00:52 PM