Skip to content

DeliveryAddressApi.md

Latest commit

 

History

History
135 lines (102 loc) · 4.58 KB

DeliveryAddressApi.md

File metadata and controls

135 lines (102 loc) · 4.58 KB

Tripletex\DeliveryAddressApi

All URIs are relative to https://tripletex.no/v2

Method HTTP request Description
get GET /deliveryAddress/{id} Get address by ID.
search GET /deliveryAddress Find addresses corresponding with sent data.

get

\Tripletex\Model\ResponseWrapperDeliveryAddress get($id, $fields)

Get address by ID.

Example

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


$apiInstance = new Tripletex\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->get($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryAddressApi->get: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Tripletex\Model\ResponseWrapperDeliveryAddress

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

search

\Tripletex\Model\ListResponseDeliveryAddress search($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 = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\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 = 56; // int | From index
$count = 56; // int | Number of elements to return
$sorting = "sorting_example"; // string | Sorting pattern
$fields = "fields_example"; // string | Fields filter pattern

try {
    $result = $apiInstance->search($id, $address_line1, $address_line2, $postal_code, $city, $name, $from, $count, $sorting, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryAddressApi->search: ', $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]
count int Number of elements to return [optional]
sorting string Sorting pattern [optional]
fields string Fields filter pattern [optional]

Return type

\Tripletex\Model\ListResponseDeliveryAddress

Authorization

tokenAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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