Download the PHP package nogrod/tyre24-common-php-sdk without Composer
On this page you can find all versions of the php package nogrod/tyre24-common-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download nogrod/tyre24-common-php-sdk
More information about nogrod/tyre24-common-php-sdk
Files in nogrod/tyre24-common-php-sdk
Download nogrod/tyre24-common-php-sdk
More information about nogrod/tyre24-common-php-sdk
Files in nogrod/tyre24-common-php-sdk
Vendor nogrod
Package tyre24-common-php-sdk
Short Description ## API Versioning We're constantly updating and improving the API, and while we try to ensure backwards compatibility, there's always a chance that we'll introduce a change that affects the way your app works. To get around any problems that this might cause, we recommend that you include the Accept header with every API request that you make. This header enables you to target your request to a particular version of the API. It looks like this in HTTP: ```text Accept: application/vnd.saitowag.api+json;version={version_number} ``` Normally, you set the value of the placeholder to the current version of the API. But if you're troubleshooting your app, and you know that an older version of the API works perfectly, say version 1.0, you'd substitute 1.0 for the placeholder value. The API then handles the request as if it were for version 1.0, and your app goes back to working properly. ### Example of an error with invalid `ACCEPT` header. The `HTTP status code` in case of an invalid `ACCEPT` header will be `400 Bad Request` and the following response will be returned. ```json { "data": [ { "error_code": "ERR_ACCEPT_HEADER_NOT_VALID", "error_message": "Accept header is not valid or not set." } ] } ``` ### Unexpected Error If an unexpected error occours, a so called Error General will be returned. The `HTTP status code` in case of an invalid `ACCEPT` header will be `500` and the following response will be returned. ```json { "data": [ { "error_code": "ERR_GENERAL", "error_message": "An unexpected error has occurred. If this problem persists, please contact our support." } ] } ``` ### Invalid Endpoint Error Any call to a non-existing API endpoint (i.e. wrong route) will return a response with `HTTP status code` `404` and the following response body: ```json { "data": [ { "error_code": "ERR_GENERAL_INVALID_ENDPOINT", "error_message": "The requested endpoint does not exist." } ] } ``` Please, note that this error is returned also when a request parameter, part of a valid route, is not well formed. For example, a call to a route that contains a wrong order id (i.e. it does not meet the accepted order id pattern - e.g. 123456789PAC instead of PAC123456789) will return the error just mentioned, as the route is considered as badly formed. In conclusion, please pay special attention to all those routes that have request parameters with specific pattern requirements. ### Shipping Method IDs These ids may not be available in all the countries. | ID | Name | | --- | --- | | 1 | Standard `Standard` | | 2 | Self-collection `Selbstabholung` | | 3 | Express morning (truck) `Express-Morgen (LKW)` | | 4 | Express Today (Truck) `Express-Heute (LKW)` | | 5 | Express morning (package forwarding) `Express-Morgen (Packet Spedition)` | | 7 | Express-now | ### Payment Method IDs These ids may not be available in all the countries. | ID | Name | | --- | --- | | 1 | SEPA Direct Debit `SEPA-Lastschrift` | | 2 | Prepayment `Vorkasse` | | 3 | Cash on delivery `Nachnahme` | | 4 | PayPal/Credit Card `PayPal/Kreditkarte` | | 5 | open payment method `offene Zahlungsart` | | 7 | Invoice(8 days payment term) `Rechnung(8 Tage Zahlungsziel)` | | 8 | open payment method (SEPA) `offene Zahlungsart (SEPA)` | ## Query String Filters
float: `{url}?filter[average]=eq;3.7`
string: `{url}?filter[free_text]=eq;apple`
Date: `{url}?filter[birthday]=eq;2020-06-03`
DateTime: `{url}?filter[created_at]=eq;2020-06-03 14:32:32`
boolean: `{url}?filter[is_active]=eq;1`
| | neq | Not equal | Used to exclude the value from a query result. It adds the "**<>**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=neq;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} <> 11` | integer: `{url}?filter[id]=neq;21`
float: `{url}?filter[average]=neq;3.7`
string: `{url}?filter[free_text]=neq;apple`
Date: `{url}?filter[birthday]=neq;2020-06-03`
DateTime: `{url}?filter[created_at]=neq;2020-06-03 14:32:32`
boolean: `{url}?filter[is_active]=neq;1`
| | gt | Greater than | Used to reduce fetched values to those greater than the one provided in a query string. It adds the "**>**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=gt;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} > 11` | integer: `{url}?filter[id]=gt;21`
float: `{url}?filter[average]=gt;3.7`
Date: `{url}?filter[birthday]=gt;2020-06-03`
DateTime: `{url}?filter[created_at]=gt;2020-06-03 14:32:32`
| | gte | Greater than or equal | Used to reduce fetched values to those greater than or equal to the one provided in a query string. It adds the "**>=**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=gte;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} >= 11` | integer: `{url}?filter[id]=gte;21`
float: `{url}?filter[average]=gte;3.7`
Date: `{url}?filter[birthday]=gte;2020-06-03`
DateTime: `{url}?filter[created_at]=gte;2020-06-03 14:32:32`
| | lt | Less than | Used to reduce fetched values to those less than provided in a query string. It adds the "**<**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=lt;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} < 11` | integer: `{url}?filter[id]=lt;21`
float: `{url}?filter[average]=lt;3.7`
Date: `{url}?filter[birthday]=lt;2020-06-03`
DateTime: `{url}?filter[created_at]=lt;2020-06-03 14:32:32`
| | lte | Less than or equal | Used to reduce fetched values to those less than or equal to the one provided in a query string. It adds the "**<=**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=lte;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} <= 11` | integer: `{url}?filter[id]=lte;21`
float: `{url}?filter[average]=lte;3.7`
Date: `{url}?filter[birthday]=lte;2020-06-03`
DateTime: `{url}?filter[created_at]=lte;2020-06-03 14:32:32`
| | in | In | Used to narrow down the query result to multiple, specific entries. It adds the **IN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=in;1,2,3,4` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IN (1, 2, 3, 4)` | integer: `{url}?filter[id]=in;21,55,76`
float: `{url}?filter[average]=in;3.7,6.5,9.9`
string: `{url}?filter[free_text]=in;apple,pear,watermelon`
Date: `{url}?filter[birthday]=in;2020-06-03,2021-10-13,2021-10-14`
DateTime: `{url}?filter[created_at]=in;2020-06-03 14:32:32,2020-09-12 17:35:32,2021-06-04 15:36:32`
| | nin | Not in | Used to exclude multiple values from query result. It adds the **NOT IN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nin;1,2,3,4` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} NOT IN (1, 2, 3, 4)` | integer: `{url}?filter[id]=nin;21,55,76`
float: `{url}?filter[average]=nin;3.7,6.5,9.9`
string: `{url}?filter[free_text]=nin;apple,pear,watermelon`
Date: `{url}?filter[birthday]=nin;2020-06-03,2021-10-13,2021-10-14`
DateTime: `{url}?filter[created_at]=nin;2020-06-03 14:32:32,2020-09-12 17:35:32,2021-06-04 15:36:32`
| | wc | Like | Used to find specified pattern. It adds the **LIKE** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=wc;j**n** doe` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} LIKE 'j%n% doe'` | string: `{url}?filter[free_text]=wc;j**n** doe`
| | nwc | Not like | Used to find everything but the specified pattern. It adds the **NOT LIKE** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nwc;j**n** doe` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} NOT LIKE 'j%n% doe'` | string: `{url}?filter[free_text]=nwc;j**n** doe`
| | btw | Between | Used to find results containing values between two, specified values. It adds the **BETWEEN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=btw;10,20` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} BETWEEN 10 AND 20` | integer: `{url}?filter[id]=btw;21,55`
float: `{url}?filter[average]=btw;3.7,6.5`
Date: `{url}?filter[birthday]=btw;2020-06-03,2021-10-13`
DateTime: `{url}?filter[created_at]=btw;2020-06-03 14:32:32,2020-09-12 17:35:32`
| | rxp | Regular expression | Used to find results matching the regular expression. It adds the **REGEXP** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=rxp;j(oh\|a)ne` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} REGEXP 'j(oh\|a)ne?'` | string: `{url}?filter[free_text]=rxp;j(oh\|a)ne?`
| | null | Is null | Used to find results that values of specified column are set to null. It adds the **IS NULL** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=null;` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IS NULL` | integer: `{url}?filter[id]=null;`
float: `{url}?filter[average]=null;`
string: `{url}?filter[free_text]=null;`
Date: `{url}?filter[birthday]=null;`
DateTime: `{url}?filter[created_at]=null;`
boolean: `{url}?filter[is_active]=null;`
| | nnull | Is not null | Used to find results that values of specified column are not set to null. It adds the **IS NOT NULL** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nnull;` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IS NOT NULL` | integer: `{url}?filter[id]=nnull;`
float: `{url}?filter[average]=nnull;`
string: `{url}?filter[free_text]=nnull;`
Date: `{url}?filter[birthday]=nnull;`
DateTime: `{url}?filter[created_at]=nnull;`
boolean: `{url}?filter[is_active]=nnull;`
| ### Additional information If you want to filter by multiple columns, you can do that, so `{url}?filter[id]=gt;3&filter[email]=like;**@gmail.com&filter[is_active]=eq;1` is a valid query string. However you are not allowed to use one operator multiple times, for the same column. So `{url}?filter[id]=gte;3&filter[id]=lte;5` is not going to work and might result in unexpected behavior. You can achieve similar result using `{url}?filter[id]=btw;3,5`. # Changelog ## Added endpoints - `PATCH /common/message/read`
License unlicense
Homepage https://openapi-generator.tech
Package tyre24-common-php-sdk
Short Description ## API Versioning We're constantly updating and improving the API, and while we try to ensure backwards compatibility, there's always a chance that we'll introduce a change that affects the way your app works. To get around any problems that this might cause, we recommend that you include the Accept header with every API request that you make. This header enables you to target your request to a particular version of the API. It looks like this in HTTP: ```text Accept: application/vnd.saitowag.api+json;version={version_number} ``` Normally, you set the value of the placeholder to the current version of the API. But if you're troubleshooting your app, and you know that an older version of the API works perfectly, say version 1.0, you'd substitute 1.0 for the placeholder value. The API then handles the request as if it were for version 1.0, and your app goes back to working properly. ### Example of an error with invalid `ACCEPT` header. The `HTTP status code` in case of an invalid `ACCEPT` header will be `400 Bad Request` and the following response will be returned. ```json { "data": [ { "error_code": "ERR_ACCEPT_HEADER_NOT_VALID", "error_message": "Accept header is not valid or not set." } ] } ``` ### Unexpected Error If an unexpected error occours, a so called Error General will be returned. The `HTTP status code` in case of an invalid `ACCEPT` header will be `500` and the following response will be returned. ```json { "data": [ { "error_code": "ERR_GENERAL", "error_message": "An unexpected error has occurred. If this problem persists, please contact our support." } ] } ``` ### Invalid Endpoint Error Any call to a non-existing API endpoint (i.e. wrong route) will return a response with `HTTP status code` `404` and the following response body: ```json { "data": [ { "error_code": "ERR_GENERAL_INVALID_ENDPOINT", "error_message": "The requested endpoint does not exist." } ] } ``` Please, note that this error is returned also when a request parameter, part of a valid route, is not well formed. For example, a call to a route that contains a wrong order id (i.e. it does not meet the accepted order id pattern - e.g. 123456789PAC instead of PAC123456789) will return the error just mentioned, as the route is considered as badly formed. In conclusion, please pay special attention to all those routes that have request parameters with specific pattern requirements. ### Shipping Method IDs These ids may not be available in all the countries. | ID | Name | | --- | --- | | 1 | Standard `Standard` | | 2 | Self-collection `Selbstabholung` | | 3 | Express morning (truck) `Express-Morgen (LKW)` | | 4 | Express Today (Truck) `Express-Heute (LKW)` | | 5 | Express morning (package forwarding) `Express-Morgen (Packet Spedition)` | | 7 | Express-now | ### Payment Method IDs These ids may not be available in all the countries. | ID | Name | | --- | --- | | 1 | SEPA Direct Debit `SEPA-Lastschrift` | | 2 | Prepayment `Vorkasse` | | 3 | Cash on delivery `Nachnahme` | | 4 | PayPal/Credit Card `PayPal/Kreditkarte` | | 5 | open payment method `offene Zahlungsart` | | 7 | Invoice(8 days payment term) `Rechnung(8 Tage Zahlungsziel)` | | 8 | open payment method (SEPA) `offene Zahlungsart (SEPA)` | ## Query String Filters
Query String Filters
| Operator | Full Name | Description | Example | | ------ | ------ | ------ | ------ | | eq | Equal | Used to narrow down the result of a query to some specific value, for specified field. It adds the "**=**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=eq;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} = 11` | integer: `{url}?filter[id]=eq;21`float: `{url}?filter[average]=eq;3.7`
string: `{url}?filter[free_text]=eq;apple`
Date: `{url}?filter[birthday]=eq;2020-06-03`
DateTime: `{url}?filter[created_at]=eq;2020-06-03 14:32:32`
boolean: `{url}?filter[is_active]=eq;1`
| | neq | Not equal | Used to exclude the value from a query result. It adds the "**<>**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=neq;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} <> 11` | integer: `{url}?filter[id]=neq;21`
float: `{url}?filter[average]=neq;3.7`
string: `{url}?filter[free_text]=neq;apple`
Date: `{url}?filter[birthday]=neq;2020-06-03`
DateTime: `{url}?filter[created_at]=neq;2020-06-03 14:32:32`
boolean: `{url}?filter[is_active]=neq;1`
| | gt | Greater than | Used to reduce fetched values to those greater than the one provided in a query string. It adds the "**>**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=gt;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} > 11` | integer: `{url}?filter[id]=gt;21`
float: `{url}?filter[average]=gt;3.7`
Date: `{url}?filter[birthday]=gt;2020-06-03`
DateTime: `{url}?filter[created_at]=gt;2020-06-03 14:32:32`
| | gte | Greater than or equal | Used to reduce fetched values to those greater than or equal to the one provided in a query string. It adds the "**>=**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=gte;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} >= 11` | integer: `{url}?filter[id]=gte;21`
float: `{url}?filter[average]=gte;3.7`
Date: `{url}?filter[birthday]=gte;2020-06-03`
DateTime: `{url}?filter[created_at]=gte;2020-06-03 14:32:32`
| | lt | Less than | Used to reduce fetched values to those less than provided in a query string. It adds the "**<**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=lt;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} < 11` | integer: `{url}?filter[id]=lt;21`
float: `{url}?filter[average]=lt;3.7`
Date: `{url}?filter[birthday]=lt;2020-06-03`
DateTime: `{url}?filter[created_at]=lt;2020-06-03 14:32:32`
| | lte | Less than or equal | Used to reduce fetched values to those less than or equal to the one provided in a query string. It adds the "**<=**" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=lte;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} <= 11` | integer: `{url}?filter[id]=lte;21`
float: `{url}?filter[average]=lte;3.7`
Date: `{url}?filter[birthday]=lte;2020-06-03`
DateTime: `{url}?filter[created_at]=lte;2020-06-03 14:32:32`
| | in | In | Used to narrow down the query result to multiple, specific entries. It adds the **IN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=in;1,2,3,4` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IN (1, 2, 3, 4)` | integer: `{url}?filter[id]=in;21,55,76`
float: `{url}?filter[average]=in;3.7,6.5,9.9`
string: `{url}?filter[free_text]=in;apple,pear,watermelon`
Date: `{url}?filter[birthday]=in;2020-06-03,2021-10-13,2021-10-14`
DateTime: `{url}?filter[created_at]=in;2020-06-03 14:32:32,2020-09-12 17:35:32,2021-06-04 15:36:32`
| | nin | Not in | Used to exclude multiple values from query result. It adds the **NOT IN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nin;1,2,3,4` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} NOT IN (1, 2, 3, 4)` | integer: `{url}?filter[id]=nin;21,55,76`
float: `{url}?filter[average]=nin;3.7,6.5,9.9`
string: `{url}?filter[free_text]=nin;apple,pear,watermelon`
Date: `{url}?filter[birthday]=nin;2020-06-03,2021-10-13,2021-10-14`
DateTime: `{url}?filter[created_at]=nin;2020-06-03 14:32:32,2020-09-12 17:35:32,2021-06-04 15:36:32`
| | wc | Like | Used to find specified pattern. It adds the **LIKE** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=wc;j**n** doe` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} LIKE 'j%n% doe'` | string: `{url}?filter[free_text]=wc;j**n** doe`
| | nwc | Not like | Used to find everything but the specified pattern. It adds the **NOT LIKE** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nwc;j**n** doe` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} NOT LIKE 'j%n% doe'` | string: `{url}?filter[free_text]=nwc;j**n** doe`
| | btw | Between | Used to find results containing values between two, specified values. It adds the **BETWEEN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=btw;10,20` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} BETWEEN 10 AND 20` | integer: `{url}?filter[id]=btw;21,55`
float: `{url}?filter[average]=btw;3.7,6.5`
Date: `{url}?filter[birthday]=btw;2020-06-03,2021-10-13`
DateTime: `{url}?filter[created_at]=btw;2020-06-03 14:32:32,2020-09-12 17:35:32`
| | rxp | Regular expression | Used to find results matching the regular expression. It adds the **REGEXP** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=rxp;j(oh\|a)ne` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} REGEXP 'j(oh\|a)ne?'` | string: `{url}?filter[free_text]=rxp;j(oh\|a)ne?`
| | null | Is null | Used to find results that values of specified column are set to null. It adds the **IS NULL** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=null;` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IS NULL` | integer: `{url}?filter[id]=null;`
float: `{url}?filter[average]=null;`
string: `{url}?filter[free_text]=null;`
Date: `{url}?filter[birthday]=null;`
DateTime: `{url}?filter[created_at]=null;`
boolean: `{url}?filter[is_active]=null;`
| | nnull | Is not null | Used to find results that values of specified column are not set to null. It adds the **IS NOT NULL** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nnull;` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IS NOT NULL` | integer: `{url}?filter[id]=nnull;`
float: `{url}?filter[average]=nnull;`
string: `{url}?filter[free_text]=nnull;`
Date: `{url}?filter[birthday]=nnull;`
DateTime: `{url}?filter[created_at]=nnull;`
boolean: `{url}?filter[is_active]=nnull;`
|
License unlicense
Homepage https://openapi-generator.tech
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package tyre24-common-php-sdk
OpenAPIClient-php
API Versioning
We're constantly updating and improving the API, and while we try to ensure backwards compatibility, there's always a chance that we'll introduce a change that affects the way your app works.
To get around any problems that this might cause, we recommend that you include the Accept header with every API request that you make. This header enables you to target your request to a particular version of the API. It looks like this in HTTP:
Normally, you set the value of the placeholder to the current version of the API. But if you're troubleshooting your app, and you know that an older version of the API works perfectly, say version 1.0, you'd substitute 1.0 for the placeholder value. The API then handles the request as if it were for version 1.0, and your app goes back to working properly.
Example of an error with invalid ACCEPT header.
The HTTP status code in case of an invalid ACCEPT header will be 400 Bad Request and the following response will be returned.
Unexpected Error
If an unexpected error occours, a so called Error General will be returned.
The HTTP status code in case of an invalid ACCEPT header will be 500 and the following response will be returned.
Invalid Endpoint Error
Any call to a non-existing API endpoint (i.e. wrong route) will return a response with HTTP status code 404
and the following response body:
Please, note that this error is returned also when a request parameter, part of a valid route, is not well formed. For example, a call to a route that contains a wrong order id (i.e. it does not meet the accepted order id pattern - e.g. 123456789PAC instead of PAC123456789) will return the error just mentioned, as the route is considered as badly formed.
In conclusion, please pay special attention to all those routes that have request parameters with specific pattern requirements.
Shipping Method IDs
These ids may not be available in all the countries.
| ID | Name |
|---|---|
| 1 | Standard Standard |
| 2 | Self-collection Selbstabholung |
| 3 | Express morning (truck) Express-Morgen (LKW) |
| 4 | Express Today (Truck) Express-Heute (LKW) |
| 5 | Express morning (package forwarding) Express-Morgen (Packet Spedition) |
| 7 | Express-now |
Payment Method IDs
These ids may not be available in all the countries.
| ID | Name |
|---|---|
| 1 | SEPA Direct Debit SEPA-Lastschrift |
| 2 | Prepayment Vorkasse |
| 3 | Cash on delivery Nachnahme |
| 4 | PayPal/Credit Card PayPal/Kreditkarte |
| 5 | open payment method offene Zahlungsart |
| 7 | Invoice(8 days payment term) Rechnung(8 Tage Zahlungsziel) |
| 8 | open payment method (SEPA) offene Zahlungsart (SEPA) |
Query String Filters
Query String Filters
| Operator | Full Name | Description | Example | | ------ | ------ | ------ | ------ | | eq | Equal | Used to narrow down the result of a query to some specific value, for specified field. It adds the \"**=**\" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=eq;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} = 11` | integer: `{url}?filter[id]=eq;21`float: `{url}?filter[average]=eq;3.7`
string: `{url}?filter[free_text]=eq;apple`
Date: `{url}?filter[birthday]=eq;2020-06-03`
DateTime: `{url}?filter[created_at]=eq;2020-06-03 14:32:32`
boolean: `{url}?filter[is_active]=eq;1`
| | neq | Not equal | Used to exclude the value from a query result. It adds the \"**<>**\" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=neq;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} <> 11` | integer: `{url}?filter[id]=neq;21`
float: `{url}?filter[average]=neq;3.7`
string: `{url}?filter[free_text]=neq;apple`
Date: `{url}?filter[birthday]=neq;2020-06-03`
DateTime: `{url}?filter[created_at]=neq;2020-06-03 14:32:32`
boolean: `{url}?filter[is_active]=neq;1`
| | gt | Greater than | Used to reduce fetched values to those greater than the one provided in a query string. It adds the \"**>**\" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=gt;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} > 11` | integer: `{url}?filter[id]=gt;21`
float: `{url}?filter[average]=gt;3.7`
Date: `{url}?filter[birthday]=gt;2020-06-03`
DateTime: `{url}?filter[created_at]=gt;2020-06-03 14:32:32`
| | gte | Greater than or equal | Used to reduce fetched values to those greater than or equal to the one provided in a query string. It adds the \"**>=**\" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=gte;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} >= 11` | integer: `{url}?filter[id]=gte;21`
float: `{url}?filter[average]=gte;3.7`
Date: `{url}?filter[birthday]=gte;2020-06-03`
DateTime: `{url}?filter[created_at]=gte;2020-06-03 14:32:32`
| | lt | Less than | Used to reduce fetched values to those less than provided in a query string. It adds the \"**<**\" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=lt;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} < 11` | integer: `{url}?filter[id]=lt;21`
float: `{url}?filter[average]=lt;3.7`
Date: `{url}?filter[birthday]=lt;2020-06-03`
DateTime: `{url}?filter[created_at]=lt;2020-06-03 14:32:32`
| | lte | Less than or equal | Used to reduce fetched values to those less than or equal to the one provided in a query string. It adds the \"**<=**\" symbol to the SQL query. Eg. `{url}?filter[{alias_name}]=lte;11` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} <= 11` | integer: `{url}?filter[id]=lte;21`
float: `{url}?filter[average]=lte;3.7`
Date: `{url}?filter[birthday]=lte;2020-06-03`
DateTime: `{url}?filter[created_at]=lte;2020-06-03 14:32:32`
| | in | In | Used to narrow down the query result to multiple, specific entries. It adds the **IN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=in;1,2,3,4` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IN (1, 2, 3, 4)` | integer: `{url}?filter[id]=in;21,55,76`
float: `{url}?filter[average]=in;3.7,6.5,9.9`
string: `{url}?filter[free_text]=in;apple,pear,watermelon`
Date: `{url}?filter[birthday]=in;2020-06-03,2021-10-13,2021-10-14`
DateTime: `{url}?filter[created_at]=in;2020-06-03 14:32:32,2020-09-12 17:35:32,2021-06-04 15:36:32`
| | nin | Not in | Used to exclude multiple values from query result. It adds the **NOT IN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nin;1,2,3,4` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} NOT IN (1, 2, 3, 4)` | integer: `{url}?filter[id]=nin;21,55,76`
float: `{url}?filter[average]=nin;3.7,6.5,9.9`
string: `{url}?filter[free_text]=nin;apple,pear,watermelon`
Date: `{url}?filter[birthday]=nin;2020-06-03,2021-10-13,2021-10-14`
DateTime: `{url}?filter[created_at]=nin;2020-06-03 14:32:32,2020-09-12 17:35:32,2021-06-04 15:36:32`
| | wc | Like | Used to find specified pattern. It adds the **LIKE** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=wc;j**n** doe` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} LIKE 'j%n% doe'` | string: `{url}?filter[free_text]=wc;j**n** doe`
| | nwc | Not like | Used to find everything but the specified pattern. It adds the **NOT LIKE** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nwc;j**n** doe` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} NOT LIKE 'j%n% doe'` | string: `{url}?filter[free_text]=nwc;j**n** doe`
| | btw | Between | Used to find results containing values between two, specified values. It adds the **BETWEEN** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=btw;10,20` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} BETWEEN 10 AND 20` | integer: `{url}?filter[id]=btw;21,55`
float: `{url}?filter[average]=btw;3.7,6.5`
Date: `{url}?filter[birthday]=btw;2020-06-03,2021-10-13`
DateTime: `{url}?filter[created_at]=btw;2020-06-03 14:32:32,2020-09-12 17:35:32`
| | rxp | Regular expression | Used to find results matching the regular expression. It adds the **REGEXP** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=rxp;j(oh\\|a)ne` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} REGEXP 'j(oh\\|a)ne?'` | string: `{url}?filter[free_text]=rxp;j(oh\\|a)ne?`
| | null | Is null | Used to find results that values of specified column are set to null. It adds the **IS NULL** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=null;` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IS NULL` | integer: `{url}?filter[id]=null;`
float: `{url}?filter[average]=null;`
string: `{url}?filter[free_text]=null;`
Date: `{url}?filter[birthday]=null;`
DateTime: `{url}?filter[created_at]=null;`
boolean: `{url}?filter[is_active]=null;`
| | nnull | Is not null | Used to find results that values of specified column are not set to null. It adds the **IS NOT NULL** keyword to the SQL query. Eg. `{url}?filter[{alias_name}]=nnull;` will result in the following sql: `SELECT {field_name} AS {alias_name} FROM {table_name} WHERE {alias_name} IS NOT NULL` | integer: `{url}?filter[id]=nnull;`
float: `{url}?filter[average]=nnull;`
string: `{url}?filter[free_text]=nnull;`
Date: `{url}?filter[birthday]=nnull;`
DateTime: `{url}?filter[created_at]=nnull;`
boolean: `{url}?filter[is_active]=nnull;`
|
Additional information
If you want to filter by multiple columns, you can do that, so {url}?filter[id]=gt;3&filter[email]=like;**@gmail.com&filter[is_active]=eq;1 is a valid query string.
However you are not allowed to use one operator multiple times, for the same column. So {url}?filter[id]=gte;3&filter[id]=lte;5 is not going to work and might result in unexpected behavior. You can achieve similar result using {url}?filter[id]=btw;3,5.
Changelog
Added endpoints
PATCH /common/message/read
For more information, please visit https://www.alzura.com.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json:
Then run composer install
Manual Installation
Download the files and include autoload.php:
Getting Started
Please follow the installation procedure and then run the following:
API Endpoints
All URIs are relative to https://api-b2b.alzura.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ArticlesApi | getAvailableArticleTypesList | GET /common/article-types | Get the article types list. |
| AuthenticationApi | loginUser | GET /common/login | Get a login token and expire date. |
| DocumentsApi | getDocumentsByTypeAndId | GET /common/document | Get base64 encoded documents. |
| MessagesApi | markMessagesReadByMessageIds | PATCH /common/message/read | Mark messages as read |
| OrdersApi | getAvailableOrderStatusesList | GET /common/order-status | Get a list of order statuses. |
| OrdersApi | getLatestOrders | GET /common/latestorders | Retrieve the latest orders. |
| OrdersApi | getOrderDetailsByOrderId | GET /common/order/{order} | Get the details of a given order. |
| PaymentsApi | getPaymentMethodsForAuthenticatedUser | GET /common/payment-methods | Get all available payment methods for the authenticated user in the given country. |
| PingApi | ping | GET /ping | Ping. |
| ShippingApi | getShippingCompaniesByCountry | GET /common/shipping-companies | Get a list of shipping companies in a given country. |
Models
- AccessControlErrorResponse
- Address
- Assurance
- Attribute
- B2bFormError
- Bank
- BusinessPartner
- BusinessPartnerLatest
- CheckOption
- ChildBranch
- Contact
- ContactLatest
- CreditReform
- Currency
- DeliveryAddress
- Document
- GetAvailableArticleTypesList200Response
- GetAvailableArticleTypesList400Response
- GetAvailableArticleTypesList401Response
- GetAvailableArticleTypesListFilterParameterInner
- GetAvailableOrderStatusesList200Response
- GetAvailableOrderStatusesListFilterParameterInner
- GetDocumentsByTypeAndId200Response
- GetDocumentsByTypeAndIdFilterParameterInner
- GetLatestOrders200Response
- GetOrderDetailsByOrderId200Response
- GetPaymentMethodsForAuthenticatedUser200Response
- GetShippingCompaniesByCountry200Response
- GetShippingCompaniesByCountryFilterParameterInner
- Invoice
- LoginToken
- LoginUser200Response
- LoginUser401Response
- Message
- MessageIds
- Method
- OrderPosition
- Organisation
- Payment
- Ping200Response
- PositionPrice
- Price
- ResponseArticleType
- ResponseAuthError
- ResponseCommonGetPaymentMethods
- ResponseCommonGetShippingCompany
- ResponseDetails
- ResponseDocument
- ResponseDocumentData
- ResponseOrderLatest
- ResponseStatus
- Shipping
- ShippingMethod
- Tax
- TrackingNumber
Authorization
API-Key
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
basicAuth
- Type: HTTP basic authentication
basicAuthOperator
- Type: HTTP basic authentication
X-AUTH-TOKEN
- Type: API key
- API key parameter name: X-AUTH-TOKEN
- Location: HTTP header
X-AUTH-TOKEN-OPERATOR
- Type: API key
- API key parameter name: X-AUTH-TOKEN
- Location: HTTP header
OAuthAccessToken
- Type: Bearer authentication (JWT)
Tests
To run the tests, use:
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.1- Generator version:
7.10.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen
All versions of tyre24-common-php-sdk with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.1
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.4.5
guzzlehttp/psr7 Version ^2.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.4.5
guzzlehttp/psr7 Version ^2.0
The package nogrod/tyre24-common-php-sdk contains the following files
Loading the files please wait ....