Skip to content

PostReturnAddressApi.md

Latest commit

 

History

History
291 lines (208 loc) · 9.07 KB

PostReturnAddressApi.md

File metadata and controls

291 lines (208 loc) · 9.07 KB

ClickSend\PostReturnAddressApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
postReturnAddressesByReturnAddressIdDelete DELETE /post/return-addresses/{return_address_id} Delete specific post return address
postReturnAddressesByReturnAddressIdGet GET /post/return-addresses/{return_address_id} Get specific post return address
postReturnAddressesByReturnAddressIdPut PUT /post/return-addresses/{return_address_id} Update post return address
postReturnAddressesGet GET /post/return-addresses Get list of post return addresses
postReturnAddressesPost POST /post/return-addresses Create post return address

postReturnAddressesByReturnAddressIdDelete

string postReturnAddressesByReturnAddressIdDelete($return_address_id)

Delete specific post return address

Delete specific post return address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\PostReturnAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$return_address_id = 56; // int | Return address ID

try {
    $result = $apiInstance->postReturnAddressesByReturnAddressIdDelete($return_address_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostReturnAddressApi->postReturnAddressesByReturnAddressIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
return_address_id int Return address ID

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postReturnAddressesByReturnAddressIdGet

string postReturnAddressesByReturnAddressIdGet($return_address_id)

Get specific post return address

Get specific post return address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\PostReturnAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$return_address_id = 56; // int | Return address ID

try {
    $result = $apiInstance->postReturnAddressesByReturnAddressIdGet($return_address_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostReturnAddressApi->postReturnAddressesByReturnAddressIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
return_address_id int Return address ID

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postReturnAddressesByReturnAddressIdPut

string postReturnAddressesByReturnAddressIdPut($body, $return_address_id)

Update post return address

Update post return address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\PostReturnAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \ClickSend\Model\Address(); // \ClickSend\Model\Address | Address model
$return_address_id = 56; // int | Return address ID

try {
    $result = $apiInstance->postReturnAddressesByReturnAddressIdPut($body, $return_address_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostReturnAddressApi->postReturnAddressesByReturnAddressIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \ClickSend\Model\Address Address model
return_address_id int Return address ID

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postReturnAddressesGet

string postReturnAddressesGet($page, $limit)

Get list of post return addresses

Get list of post return addresses

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\PostReturnAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | Page number
$limit = 10; // int | Number of records per page

try {
    $result = $apiInstance->postReturnAddressesGet($page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostReturnAddressApi->postReturnAddressesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int Page number [optional] [default to 1]
limit int Number of records per page [optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postReturnAddressesPost

string postReturnAddressesPost($body)

Create post return address

Create post return address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\PostReturnAddressApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \ClickSend\Model\Address(); // \ClickSend\Model\Address | Address model

try {
    $result = $apiInstance->postReturnAddressesPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PostReturnAddressApi->postReturnAddressesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \ClickSend\Model\Address Address model

Return type

string

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]