Skip to main content

Get Address List

Deskripsi​

Membuat API service bagi user open API untuk mengambil data alamat pembeli

MethodURL
GETbuyer-retail/address

Request​

TypeParamsValuesDescription
QUERYid
  • string
  • mandatory

ID of Buyer Retail

Response​

Success​

StatusPayload
200
{
    "shipping_address": [
    {
        "address": "Perum Rafless Hills cluster Victory Land blok V3 no 10.\nJl. Alternatif Cibubur Cileungsi.\nCimanggis, Depok - Jawa Barat.",
        "address_name": "Misne - rumah",
        "buyer_id": "631c3e1a13af7c563202c185",
        "default": false,
        "is_pii_encrypted": true,
        "recipient": "Misne Erawaty"
    },
    ]
}
ParamsDescription
shipping_address
Data Type: OBJECT
Data transmitted by response.
shipping_address.address
Data Type: STRING
Value of Shipping Address.
shipping_address.address_name
Data Type: STRING
Name of Address.
shipping_address.buyer_id
Data Type: STRING
Id of Buyer.
shipping_address.default
Data Type: BOOLEAN
Status of the address whether it is the primary address or not.
TRUE = the address is primary address / default.
FALSE = the address is not primary address / default.
shipping_address.is_pii_encrypted
Data Type: BOOLEAN
Status of the column whether it is encrypted or not.
TRUE = encrypted.
FALSE = not encrypted.
shipping_address.recipient
Data Type: STRING
Name of Buyer.

Error​

StatusPayload
404
{
    "status": "error",
    "message": "address not found"
}
ParamsDescription
status
Data Type: STRING
Status of the request delivered to server.
Available value:
* “success”
* “error”
message
Data Type: STRING
Description message for the occurring error