We announce the release of a new API version aimed at providing convenience for our partners using the service.

Lookup zipcode

GET

https://s.boxme.asiapi/v2/sellers/locations/{country_code}/zipcodes

Last modified:2024-01-02 05:25:22

Request

Path Params

country_code

string

required

Query Params

zipcode

string

optional

Example:

10520

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://s.boxme.asiapi/v2/sellers/locations//zipcodes?zipcode=10520' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json'

Responses

🟢200OK

application/json

Body

data

object

required

total_count

integer

required

zipcodes

array [object {11}]

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
    "data": {
        "total_count": 1,
        "zipcodes": [
            {
                "id": 788785,
                "country_code": "TH",
                "province_id": 190,
                "province_name": "Bangkok",
                "province_name_local": "กรุงเทพมหานคร",
                "district_id": 3356,
                "district_name": "Lad Krabang",
                "district_name_local": "เขตลาดกระบัง",
                "zipcode": "10520",
                "to_zipcode": "10520",
                "is_remote": 0
            }
        ]
    },
    "error": false,
    "error_code": "",
    "messages": "",
    "request_id": 1703235643
}

Modified at 2024-01-02 05:25:22

Sub-district

Get Pickup List