All Products
Search
Document Center

BSS OpenAPI:QueryCustomerAddressList

Last Updated:Mar 01, 2024

Queries the addresses to which invoices are mailed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bss:QueryCustomerAddressREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The error message returned.

Successful!
RequestIdstring

The ID of the request.

BBEF51A3-E933-4F40-A534-C673CBDB9C80
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

CustomerInvoiceAddressListobject []

The details of addresses to which invoices are mailed.

Addresseestring

The addressee.

test
PostalCodestring

The postcode.

000000
UserIdlong

The ID of the user.

4382956342857
Citystring

The city to which the invoice is mailed.

Hangzhou
UserNickstring

The nickname of the user.

testNick
Streetstring

The name of the street to which the invoice is mailed.

Test Street
Phonestring

The phone number of the addressee.

138xxxxxxxx
Countystring

The name of the district to which the invoice is mailed.

Test District
BizTypestring

The business type.

test
DeliveryAddressstring

The detailed address to which the invoice is mailed. This parameter is returned after fields are concatenated.

Test Address
Idlong

The ID.

311601051
Provincestring

The province to which the invoice is mailed.

Zhejiang

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "BBEF51A3-E933-4F40-A534-C673CBDB9C80",
  "Success": true,
  "Data": {
    "CustomerInvoiceAddressList": {
      "CustomerInvoiceAddress": [
        {
          "Addressee": "test",
          "PostalCode": "000000",
          "UserId": 4382956342857,
          "City": "Hangzhou\n",
          "UserNick": "testNick",
          "Street": "Test Street\n",
          "Phone": "138xxxxxxxx",
          "County": "Test District\n",
          "BizType": "test",
          "DeliveryAddress": "Test Address\n",
          "Id": 311601051,
          "Province": "Zhejiang\n"
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.