Query postcode and suburb

GET

/api/open/address/search

The data for the current interface needs to be loaded with pagination, and the request ends when the returned data list is empty.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/api/open/address/search?page=1&type=postcode&search=6025' \
--header 'version: {{shop_openapi_version}}' \
--header 'token: {{shop_openapi_token}}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": "0",
    "message": "Operation successful.",
    "data": {
        "addresslist": [
            {
                "postcode": "6025",
                "suburb": "Kunune Park",
                "city": "Port Elizabeth"
            }
        ]
    }
}

🟢200Failure

Modified at 2025-12-12 00:10:40

Retrieve recipient address list

Edit recipient address