All URIs are relative to https://app.billbee.io, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
customerAddCustomerAddress() | POST /api/v1/customers/{id}/addresses | Adds a new address to a customer |
customerCreate() | POST /api/v1/customers | Creates a new customer |
customerGetAll() | GET /api/v1/customers | Get a list of all customers |
customerGetCustomerAddress() | GET /api/v1/customers/addresses/{id} | Queries a single address from a customer |
customerGetCustomerAddresses() | GET /api/v1/customers/{id}/addresses | Queries a list of addresses from a customer |
customerGetCustomerOrders() | GET /api/v1/customers/{id}/orders | Queries a list of orders from a customer |
customerGetOne() | GET /api/v1/customers/{id} | Queries a single customer by id |
customerPatchAddress() | PATCH /api/v1/customers/addresses/{id} | Updates one or more fields of an address |
customerUpdate() | PUT /api/v1/customers/{id} | Updates a customer by id |
customerUpdateAddress() | PUT /api/v1/customers/addresses/{id} | Updates all fields of an address |
searchSearch_0() | POST /api/v1/search | Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contain lucene query syntax |
customerAddCustomerAddress($id, $model): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel
Adds a new address to a customer
Id and CustomerId will be ignored in model. If Id is set, the addition will be stopped.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | CustomerId to attach the new address to.
$model = new \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel(); // \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel | Model containing the address, that should be attached.
try {
$result = $apiInstance->customerAddCustomerAddress($id, $model);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerAddCustomerAddress: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | CustomerId to attach the new address to. | |
model | \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel | Model containing the address, that should be attached. |
- Content-Type:
application/json
,text/json
,application/xml
,text/xml
,application/x-www-form-urlencoded
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerCreate($model): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerApiModel
Creates a new customer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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
);
$model = new \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCreateCustomerApiModel(); // \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCreateCustomerApiModel
try {
$result = $apiInstance->customerCreate($model);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerCreate: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
model | \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCreateCustomerApiModel |
- Content-Type:
application/json
,text/json
,application/xml
,text/xml
,application/x-www-form-urlencoded
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerGetAll($page, $page_size): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiPagedResultOfSystemCollectionsGenericListOfBillbeeInterfacesBillbeeAPIModelCustomerApiModel
Get a list of all customers
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The current page to request starting with 1
$page_size = 50; // int | The pagesize for the result list. Values between 1 and 250 are allowed
try {
$result = $apiInstance->customerGetAll($page, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerGetAll: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
page | int | The current page to request starting with 1 | [optional] [default to 1] |
page_size | int | The pagesize for the result list. Values between 1 and 250 are allowed | [optional] [default to 50] |
- Content-Type: Not defined
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerGetCustomerAddress($id): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel
Queries a single address from a customer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the address
try {
$result = $apiInstance->customerGetCustomerAddress($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerGetCustomerAddress: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the address |
- Content-Type: Not defined
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerGetCustomerAddresses($id, $page, $page_size): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiPagedResultOfSystemCollectionsGenericListOfBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel
Queries a list of addresses from a customer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the customer
$page = 1; // int | The current page to request starting with 1
$page_size = 50; // int | The pagesize for the result list. Values between 1 and 250 are allowed
try {
$result = $apiInstance->customerGetCustomerAddresses($id, $page, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerGetCustomerAddresses: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the customer | |
page | int | The current page to request starting with 1 | [optional] [default to 1] |
page_size | int | The pagesize for the result list. Values between 1 and 250 are allowed | [optional] [default to 50] |
- Content-Type: Not defined
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerGetCustomerOrders($id, $page, $page_size): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiPagedResultOfSystemCollectionsGenericListOfRechnungsdruckWebAppControllersApiOrder
Queries a list of orders from a customer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the customer
$page = 1; // int | The current page to request starting with 1
$page_size = 50; // int | The pagesize for the result list. Values between 1 and 250 are allowed
try {
$result = $apiInstance->customerGetCustomerOrders($id, $page, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerGetCustomerOrders: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the customer | |
page | int | The current page to request starting with 1 | [optional] [default to 1] |
page_size | int | The pagesize for the result list. Values between 1 and 250 are allowed | [optional] [default to 50] |
- Content-Type: Not defined
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerGetOne($id): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerApiModel
Queries a single customer by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the customer to query
try {
$result = $apiInstance->customerGetOne($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerGetOne: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the customer to query |
- Content-Type: Not defined
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerPatchAddress($id, $model): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel
Updates one or more fields of an address
Id and CustomerId cannot be changed
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the address
$model = array('key' => new \stdClass); // object | The address fields to be changed. Please query an address via (todo) to see all fields. Note that Id and CustomerId cannot be changed.
try {
$result = $apiInstance->customerPatchAddress($id, $model);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerPatchAddress: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the address | |
model | object | The address fields to be changed. Please query an address via (todo) to see all fields. Note that Id and CustomerId cannot be changed. |
- Content-Type:
application/json
,text/json
,application/x-www-form-urlencoded
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerUpdate($id, $model): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerApiModel
Updates a customer by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the customer
$model = new \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerApiModel(); // \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerApiModel
try {
$result = $apiInstance->customerUpdate($id, $model);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerUpdate: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the customer | |
model | \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerApiModel |
- Content-Type:
application/json
,text/json
,application/xml
,text/xml
,application/x-www-form-urlencoded
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
customerUpdateAddress($id, $model): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfBillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel
Updates all fields of an address
Id and CustomerId cannot be changed. Fields you do not send will become empty.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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 | The id of the address
$model = new \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel(); // \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel | The updated address. Please query an address via (todo) to see all fields. Note that Id and CustomerId cannot be changed.
try {
$result = $apiInstance->customerUpdateAddress($id, $model);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->customerUpdateAddress: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
id | int | The id of the address | |
model | \kruegge82\billbee\Model\BillbeeInterfacesBillbeeAPIModelCustomerAddressApiModel | The updated address. Please query an address via (todo) to see all fields. Note that Id and CustomerId cannot be changed. |
- Content-Type:
application/json
,text/json
,application/xml
,text/xml
,application/x-www-form-urlencoded
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]
searchSearch_0($model): \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiApiResultOfRechnungsdruckWebAppControllersApiSearchControllerSearchResultsModel
Search for products, customers and orders. Type can be "order", "product" and / or "customer" Term can contain lucene query syntax
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
// Configure API key authorization: ApiKeyAuth
$config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKey('X-Billbee-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\billbee\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Billbee-Api-Key', 'Bearer');
$apiInstance = new kruegge82\billbee\Api\CustomersApi(
// 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
);
$model = new \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiSearchControllerSearchModel(); // \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiSearchControllerSearchModel
try {
$result = $apiInstance->searchSearch_0($model);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomersApi->searchSearch_0: ', $e->getMessage(), PHP_EOL;
}
Name | Type | Description | Notes |
---|---|---|---|
model | \kruegge82\billbee\Model\RechnungsdruckWebAppControllersApiSearchControllerSearchModel |
- Content-Type:
application/json
,text/json
,application/xml
,text/xml
,application/x-www-form-urlencoded
- Accept:
application/json
,text/json
,application/xml
,text/xml
[Back to top] [Back to API list] [Back to Model list] [Back to README]