Addresses (1.0.0)

Everything about Post Addresses

View Your Return Addresses

Get list of post return addresses

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/post/return-addresses

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/post/return-addresses'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your records.",
"data": {"total": 2,
"per_page": 15,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 2,
"data": [{"return_address_id": 4,
"user_id": 1,
"address_name": "My Address",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_city": "Flynn",
"address_state": "WA",
"address_postal_code": "6302",
"address_country": "AU"
}
]
}
}

Create Return Address

Create post return address

Properties

Name	Type	Required	Restrictions	Description
address_name	string	true	none	Your address name.
address_line_1	string	true	none	Your address line 1
address_city	string	true	none	Your city
address_postal_code	string	true	none	Your postal code
address_country	string	true	none	Your country
address_line_2	string	false	none	Your address line 2
address_state	string	false	none	Your state

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/post/return-addresses

Request samples

application/json

{"address_name": "test",
"address_line_1": "1 test street",
"address_line_2": null,
"address_city": "Test",
"address_postal_code": "6000",
"address_country": "AU"
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New return address has been added.",
"data": {"return_address_id": 4,
"user_id": 1,
"address_name": "My Address",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_city": "Flynn",
"address_state": "WA",
"address_postal_code": "6302",
"address_country": "AU"
}
}

View Specific Return Address

Get specific post return address

Parameters

Parameter	In	Type	Required	Description
return_address_id	path	integer(int32)	true	Return address ID

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

path Parameters

return_address_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/post/return-addresses/{return_address_id}

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/post/return-addresses/{return_address_id}'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your data.",
"data": {"return_address_id": 4,
"user_id": 1,
"address_name": "My Address",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_city": "Flynn",
"address_state": "WA",
"address_postal_code": "6302",
"address_country": "AU"
}
}

Update Return Address

Update post return address

Parameters

Parameter	In	Type	Required	Description
return_address_id	path	integer(int32)	true	Return address ID

Properties

Name	Type	Required	Restrictions	Description
address_name	string	true	none	Your address name.
address_line_1	string	true	none	Your address line 1
address_city	string	true	none	Your city
address_postal_code	string	true	none	Your postal code
address_country	string	true	none	Your country
address_line_2	string	false	none	Your address line 2
address_state	string	false	none	Your state

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

path Parameters

return_address_id

required

string

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

put/v3/post/return-addresses/{return_address_id}

Request samples

application/json

{"address_country": "AU",
"address_state": null
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your return address has been updated.",
"data": {"return_address_id": 4,
"user_id": 1,
"address_name": "My Address",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_city": "Flynn",
"address_state": "WA",
"address_postal_code": "6302",
"address_country": "AU"
}
}

Delete Return Address

Delete specific post return address

Parameters

Parameter	In	Type	Required	Description
return_address_id	path	integer(int32)	true	Return address ID

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

path Parameters

return_address_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

delete/v3/post/return-addresses/{return_address_id}

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \

'https://rest.clicksend.com/v3/post/return-addresses/{return_address_id}'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your return address has been deleted.",
"data": [ ]
}