Skip to content

DeliveryAddressApi.md

Latest commit

 

History

History
201 lines (143 loc) · 6.81 KB

DeliveryAddressApi.md

File metadata and controls

201 lines (143 loc) · 6.81 KB

Swagger\Client\DeliveryAddressApi

All URIs are relative to https://api.tripletex.io/v2

Method HTTP request Description
deliveryAddressGet GET /deliveryAddress/{id} Get address by ID.
deliveryAddressPut PUT /deliveryAddress/{id} Update address.
deliveryAddressSearch GET /deliveryAddress Find addresses corresponding with sent data.

deliveryAddressGet

\Swagger\Client\Model\ResponseWrapperDeliveryAddress deliveryAddressGet($id, $fields)

Get address by ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: tokenAuthScheme
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DeliveryAddressApi(
    // 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
);
$id = 56; // int | Element ID
$fields = "fields_example"; // string | Fields filter pattern

try {
    $result = $apiInstance->deliveryAddressGet($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryAddressApi->deliveryAddressGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int Element ID
fields string Fields filter pattern [optional]

Return type

\Swagger\Client\Model\ResponseWrapperDeliveryAddress

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

deliveryAddressPut

\Swagger\Client\Model\ResponseWrapperDeliveryAddress deliveryAddressPut($id, $body)

Update address.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: tokenAuthScheme
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DeliveryAddressApi(
    // 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
);
$id = 56; // int | Element ID
$body = new \Swagger\Client\Model\DeliveryAddress(); // \Swagger\Client\Model\DeliveryAddress | Partial object describing what should be updated

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

Parameters

Name Type Description Notes
id int Element ID
body \Swagger\Client\Model\DeliveryAddress Partial object describing what should be updated [optional]

Return type

\Swagger\Client\Model\ResponseWrapperDeliveryAddress

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: Not defined

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

deliveryAddressSearch

\Swagger\Client\Model\ListResponseDeliveryAddress deliveryAddressSearch($id, $address_line1, $address_line2, $postal_code, $city, $name, $from, $count, $sorting, $fields)

Find addresses corresponding with sent data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: tokenAuthScheme
$config = Swagger\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Swagger\Client\Api\DeliveryAddressApi(
    // 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
);
$id = "id_example"; // string | List of IDs
$address_line1 = "address_line1_example"; // string | List of IDs
$address_line2 = "address_line2_example"; // string | List of IDs
$postal_code = "postal_code_example"; // string | List of IDs
$city = "city_example"; // string | List of IDs
$name = "name_example"; // string | List of IDs
$from = 0; // int | From index
$count = 1000; // int | Number of elements to return
$sorting = "sorting_example"; // string | Sorting pattern
$fields = "fields_example"; // string | Fields filter pattern

try {
    $result = $apiInstance->deliveryAddressSearch($id, $address_line1, $address_line2, $postal_code, $city, $name, $from, $count, $sorting, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryAddressApi->deliveryAddressSearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string List of IDs [optional]
address_line1 string List of IDs [optional]
address_line2 string List of IDs [optional]
postal_code string List of IDs [optional]
city string List of IDs [optional]
name string List of IDs [optional]
from int From index [optional] [default to 0]
count int Number of elements to return [optional] [default to 1000]
sorting string Sorting pattern [optional]
fields string Fields filter pattern [optional]

Return type

\Swagger\Client\Model\ListResponseDeliveryAddress

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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