The new version 20250310 is available.

Edit recipient address

gecko [master]

https://shopapi.geckodistribution.com

POST

/api/open/address/edit

Request

Header Params

version

string

required

接口版本号

Default:

token

string

required

接口Token

Default:

Body Params application/json

integer <long> | null

optional

Address ID. This parameter must be assigned if an existing address needs to be updated. If a new address needs to be added, this parameter does not need to be assigned.

>= 0

Example:

2586860147562607

receiver

string

required

Recipient's name.

Example:

hardy

cellphone

string

required

Recipient's phone number.

Example:

27987654321

postcode

string

required

Postal code information of the recipient's address.

Example:

9323

suburb

string

required

Suburb information of the recipient's address.

Example:

Ashbury

city

string

required

City information of the recipient's address.

Example:

Park

address

string

required

Recipient's address.

Example:

1 Jones Rd, Kempton Park, Johannesburg, 1632

Example

{
    "id": 2586860147562607,
    "receiver": "hardy",
    "cellphone": "27987654321",
    "postcode": "9323",
    "suburb": "Ashbury",
    "city": "Park",
    "address": "1 Jones Rd, Kempton Park, Johannesburg, 1632"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://shopapi.geckodistribution.com/api/open/address/edit' \
--header 'version;' \
--header 'token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 2586860147562607,
    "receiver": "hardy",
    "cellphone": "27987654321",
    "postcode": "9323",
    "suburb": "Ashbury",
    "city": "Park",
    "address": "1 Jones Rd, Kempton Park, Johannesburg, 1632"
}'

Responses

🟢200Success

application/json

Body

status

enum<string>

required

Response status code, typically uses 0 to indicate no exceptions, and non-zero values to indicate the presence of exceptions.

Allowed values:

0500

Example:

message

string

required

Exception response message, this field usually has significance when the value of status is non-zero.

Example:

Operation successful.

data

object | null

optional

Response data.

integer <long>

optional

Address ID

>= 1

Example:

2586860147562607

Example

{
    "status": "0",
    "message": "Operation successful.",
    "data": {
        "id": 2586860147562607
    }
}

🟢200Failure

Query postcode and suburb

Clearance