Developers

Example Usage of

address_delete_group

Delete address group.

Delete an address group, just like you would on the Addresses page of the settings section.

Endpoint:

/admin/api.php?api_action=address_delete_group

HTTP method:

POST

Supported output formats:

json

Requires authentication:

true

Parameters:

* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as

Content-Type: application/x-www-form-urlencoded

. We don't accept any other input formats like JSON.

Variable

Description

api_action*

address_add

api_key*

Your API key

api_output

json

addressid*

ID of the address to delete. Example: '3' (Get available address IDs with "address_list" call)

groupid*

ID of the group you want to delete from an address. Example: '3' (Get available address list IDs with "address_list" call)

Example response:

Variable

Description

id

ID of the list just added. Example: 6

result_code

Whether or not the response was successful. Examples: 1 = yes, 0 = no

result_message

A custom message that appears explaining what happened. Example: Address list has been deleted.

result_output

The result output used. Example: json

PHP Example

This is an example of using the address_delete_group call with PHP.
You can replicate the same idea in virtually any other programming language.
The example shown is using serialize as the output format.
You can change that to XML or JSON if you would like.