SuperShip

Areas

These APIs allow developers to retrieve a list of provinces, districts, and communes supported by SuperShip for the pickup, delivery, and return of goods.

Get Province/City Information

This API allows you to retrieve information about the Provinces/Cities.

Endpoint

get/v1/partner/areas/province

Request

Example

curl --request GET \
     --url https://api.mysupership.vn/v1/partner/areas/province
1
2

Response

Returned Result

FieldTypeDescription
codeStringProvince/City code. For example: 79.
nameStringName of the Province/City. For example: Thành phố Hồ Chí Minh.

Example

{
    "status": "Success",
    "results": [
        {
            "code": "01",
            "name": "Thành phố Hà Nội"
        },
        {
            "code": "79",
            "name": "Thành phố Hồ Chí Minh"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Get District Information

This API allows you to retrieve the information about the districts.

Endpoint

get/v1/partner/areas/district

Request

Parameters

FieldRequiredTypeDescription
provinceYesStringProvince/City Code. For example: 79.

Example

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/areas/district?province=79'
1
2

Response

Returned Result

FieldTypeDescription
codeStringDistrict Code. For example: 785.
nameStringDistrict Name. For example: Huyện Bình Chánh.
provinceStringName of the Province/City. For example: Thành phố Hồ Chí Minh.

Example

{
    "status": "Success",
    "results": [
        {
            "code": "785",
            "name": "Huyện Bình Chánh",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "783",
            "name": "Huyện Củ Chi",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "784",
            "name": "Huyện Hóc Môn",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "786",
            "name": "Huyện Nhà Bè",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "760",
            "name": "Quận 1",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "771",
            "name": "Quận 10",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "772",
            "name": "Quận 11",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "761",
            "name": "Quận 12",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "769",
            "name": "Quận 2",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "770",
            "name": "Quận 3",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "773",
            "name": "Quận 4",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "774",
            "name": "Quận 5",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "775",
            "name": "Quận 6",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "778",
            "name": "Quận 7",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "776",
            "name": "Quận 8",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "763",
            "name": "Quận 9",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "777",
            "name": "Quận Bình Tân",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "765",
            "name": "Quận Bình Thạnh",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "764",
            "name": "Quận Gò Vấp",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "768",
            "name": "Quận Phú Nhuận",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "766",
            "name": "Quận Tân Bình",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "767",
            "name": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "762",
            "name": "Quận Thủ Đức",
            "province": "Thành phố Hồ Chí Minh"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

Get Ward/Commune Information

This API allows you to retrieve information about the wards/communes.

Endpoint

get/v1/partner/areas/commune

Request

Parameters

FieldRequiredTypeDescription
districtYesStringDistrict Code. For example: 767.

Example

curl --request GET \
     --url 'https://api.mysupership.vn/v1/partner/areas/commune?district=767'
1
2

Response

Returned Result

FieldTypeDescription
codeStringCommune Code. For example: 27037.
nameStringCommune Name. For example: Phường Hiệp Tân.
districtStringDistrict Name. For example: Quận Tân Phú.
provinceStringName of the Province/City. For example: Thành phố Hồ Chí Minh.

Example

{
    "status": "Success",
    "results": [
        {
            "code": "27037",
            "name": "Phường Hiệp Tân",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27034",
            "name": "Phường Hòa Thạnh",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27028",
            "name": "Phường Phú Thạnh",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27025",
            "name": "Phường Phú Thọ Hòa",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27031",
            "name": "Phường Phú Trung",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27016",
            "name": "Phường Sơn Kỳ",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27019",
            "name": "Phường Tân Quý",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27010",
            "name": "Phường Tân Sơn Nhì",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27022",
            "name": "Phường Tân Thành",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27040",
            "name": "Phường Tân Thới Hòa",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        },
        {
            "code": "27013",
            "name": "Phường Tây Thạnh",
            "district": "Quận Tân Phú",
            "province": "Thành phố Hồ Chí Minh"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
Last Updated: 4/27/2025, 4:18:37 PM

← Orders →