Skip to content

Latest commit

 

History

History
269 lines (187 loc) · 9.13 KB

OrderPosApi.md

File metadata and controls

269 lines (187 loc) · 9.13 KB
Raw

Itsmind\Sevdesk\OrderPosApi

All URIs are relative to https://my.sevdesk.de/api/v1, except if the operation defines another base path.

Method HTTP request Description
deleteOrderPos() DELETE /OrderPos/{orderPosId} Deletes an order Position
getOrderPositionById() GET /OrderPos/{orderPosId} Find order position by ID
getOrderPositions() GET /OrderPos Retrieve order positions
updateOrderPosition() PUT /OrderPos/{orderPosId} Update an existing order position

deleteOrderPos()

deleteOrderPos($order_pos_id): \Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Deletes an order Position

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\OrderPosApi(
    // 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
);
$order_pos_id = 56; // int | Id of order position resource to delete

try {
    $result = $apiInstance->deleteOrderPos($order_pos_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderPosApi->deleteOrderPos: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
order_pos_id int Id of order position resource to delete

Return type

\Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Authorization

api_key

HTTP request headers

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

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

getOrderPositionById()

getOrderPositionById($order_pos_id): \Itsmind\Sevdesk\Model\GetOrderPositionById200Response

Find order position by ID

Returns a single order position

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\OrderPosApi(
    // 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
);
$order_pos_id = 56; // int | ID of order position to return

try {
    $result = $apiInstance->getOrderPositionById($order_pos_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderPosApi->getOrderPositionById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
order_pos_id int ID of order position to return

Return type

\Itsmind\Sevdesk\Model\GetOrderPositionById200Response

Authorization

api_key

HTTP request headers

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

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

getOrderPositions()

getOrderPositions($order_id, $order_object_name, $count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetOrderPositionsById200Response

Retrieve order positions

Retrieve all order positions depending on the filters defined in the query.

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\OrderPosApi(
    // 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
);
$order_id = 56; // int | Retrieve all order positions belonging to this order. Must be provided with voucher[objectName]
$order_object_name = 'order_object_name_example'; // string | Only required if order[id] was provided. 'Order' should be used as value.
$count_all = True; // bool | If all objects should be counted
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of objects to return
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.

try {
    $result = $apiInstance->getOrderPositions($order_id, $order_object_name, $count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderPosApi->getOrderPositions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
order_id int Retrieve all order positions belonging to this order. Must be provided with voucher[objectName] [optional]
order_object_name string Only required if order[id] was provided. 'Order' should be used as value. [optional]
count_all bool If all objects should be counted [optional]
offset int Which offset to start with [optional]
limit int The max number of objects to return [optional]
embed string[] Get some additional information. Embed can handle multiple values, they must be separated by comma. [optional]

Return type

\Itsmind\Sevdesk\Model\GetOrderPositionsById200Response

Authorization

api_key

HTTP request headers

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

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

updateOrderPosition()

updateOrderPosition($order_pos_id, $model_order_pos_update): \Itsmind\Sevdesk\Model\ModelOrderPosResponse

Update an existing order position

Update an order position

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\OrderPosApi(
    // 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
);
$order_pos_id = 56; // int | ID of order position to update
$model_order_pos_update = new \Itsmind\Sevdesk\Model\ModelOrderPosUpdate(); // \Itsmind\Sevdesk\Model\ModelOrderPosUpdate | Update data

try {
    $result = $apiInstance->updateOrderPosition($order_pos_id, $model_order_pos_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderPosApi->updateOrderPosition: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
order_pos_id int ID of order position to update
model_order_pos_update \Itsmind\Sevdesk\Model\ModelOrderPosUpdate Update data [optional]

Return type

\Itsmind\Sevdesk\Model\ModelOrderPosResponse

Authorization

api_key

HTTP request headers

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

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