Yoast\MyYoastApiClient\OrderApi

All URIs are relative to https://my.yoast.test

Method	HTTP request	Description
export	GET /api/Orders/export	Get orders
getAutoRenewalCount	GET /api/Orders/auto-renewal-count
getMany	GET /api/Orders	Get orders
getManyPaged	GET /api/Orders/paged	Get orders
getOne	GET /api/Orders/{id}	Get a order
getOneByInvoice	GET /api/Orders/InvoiceNumber/{invoiceNumber}	Get a order by invoiceNumber
getProductGroupsByInvoice	GET /api/Orders/productGroups/{invoiceNumber}	Get productGroups by invoiceNumber
invoice	GET /api/Orders/{id}/invoice	Create invoice
refundInvoice	GET /api/Orders/{id}/refunds/{refundId}/invoice	Creates a credit note

export

\Yoast\MyYoastApiClient\Model\Order[] export($startDate, $endDate)

Get orders

A large export of orders between dates

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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
);
$startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 

try {
    $result = $apiInstance->export($startDate, $endDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->export: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
startDate	\DateTime
endDate	\DateTime

Return type

\Yoast\MyYoastApiClient\Model\Order[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getAutoRenewalCount

\Yoast\MyYoastApiClient\Model\AutoRenewalCountResponseDto getAutoRenewalCount($startDate, $endDate, $secret)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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
);
$startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | 
$secret = "secret_example"; // string | 

try {
    $result = $apiInstance->getAutoRenewalCount($startDate, $endDate, $secret);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->getAutoRenewalCount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
startDate	\DateTime
endDate	\DateTime
secret	string

Return type

\Yoast\MyYoastApiClient\Model\AutoRenewalCountResponseDto

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getMany

\Yoast\MyYoastApiClient\Model\Order[] getMany($filter)

Get orders

Get and filter orders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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
);
$filter = new \stdClass; // object | Used for filtering/joining the results.

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

Parameters

Name	Type	Description	Notes
filter	object	Used for filtering/joining the results.	[optional]

Return type

\Yoast\MyYoastApiClient\Model\Order[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getManyPaged

getManyPaged($filter)

Get orders

Get and filter orders

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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
);
$filter = new \stdClass; // object | Used for filtering/joining the results.

try {
    $apiInstance->getManyPaged($filter);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->getManyPaged: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	object	Used for filtering/joining the results.	[optional]

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getOne

\Yoast\MyYoastApiClient\Model\Order getOne($id, $filter)

Get a order

Get a single order

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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 = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$filter = new \stdClass; // object | Used for filtering/joining the results.

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

Parameters

Name	Type	Description	Notes
id	string
filter	object	Used for filtering/joining the results.	[optional]

Return type

\Yoast\MyYoastApiClient\Model\Order

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getOneByInvoice

\Yoast\MyYoastApiClient\Model\Order getOneByInvoice($invoiceNumber)

Get a order by invoiceNumber

Get a single order by invoiceNumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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
);
$invoiceNumber = "invoiceNumber_example"; // string | 

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

Parameters

Name	Type	Description	Notes
invoiceNumber	string

Return type

\Yoast\MyYoastApiClient\Model\Order

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getProductGroupsByInvoice

\Yoast\MyYoastApiClient\Model\ProductGroup[] getProductGroupsByInvoice($invoiceNumber)

Get productGroups by invoiceNumber

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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
);
$invoiceNumber = "invoiceNumber_example"; // string | 

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

Parameters

Name	Type	Description	Notes
invoiceNumber	string

Return type

\Yoast\MyYoastApiClient\Model\ProductGroup[]

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

invoice

invoice($id)

Create invoice

Creates a PDF for an invoice

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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 = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

try {
    $apiInstance->invoice($id);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->invoice: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

refundInvoice

refundInvoice($id, $refundId)

Creates a credit note

Creates a PDF for a credit note

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\OrderApi(
    // 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 | 
$refundId = "refundId_example"; // string | 

try {
    $apiInstance->refundInvoice($id, $refundId);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->refundInvoice: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string
refundId	string

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

OrderApi.md

Latest commit

History

OrderApi.md

File metadata and controls

Yoast\MyYoastApiClient\OrderApi

export

Example

Parameters

Return type

Authorization

HTTP request headers

getAutoRenewalCount

Example

Parameters

Return type

Authorization

HTTP request headers

getMany

Example

Parameters

Return type

Authorization

HTTP request headers

getManyPaged

Example

Parameters

Return type

Authorization

HTTP request headers

getOne

Example

Parameters

Return type

Authorization

HTTP request headers

getOneByInvoice

Example

Parameters

Return type

Authorization

HTTP request headers

getProductGroupsByInvoice

Example

Parameters

Return type

Authorization

HTTP request headers

invoice

Example

Parameters

Return type

Authorization

HTTP request headers

refundInvoice

Example

Parameters

Return type

Authorization

HTTP request headers