nogrod/tyre24-common-php-sdk

## 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 Accep

Maintainers

Details

github.com/Nogrod/tyre24-common-php-sdk

Homepage

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v0.1.1 2024-12-02 15:02 UTC

Requires

Requires (Dev)

unlicense 8b3cf71cf7e7cf52b1f30a5572d1cedca10f221e

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2025-03-27 14:00:20 UTC

README

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:

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.

  {
    \"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.

{
  \"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:

{
  \"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;

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:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/nogrod/tyre24-common-php-sdk.git"
    }
  ],
  "require": {
    "nogrod/tyre24-common-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer (JWT) authorization: OAuthAccessToken
$config = Tyre24\Common\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: X-AUTH-TOKEN
$config = Tyre24\Common\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Tyre24\Common\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');


$apiInstance = new Tyre24\Common\Api\ArticlesApi(
    // 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
);
$country = de; // string | country code in ISO 3166-1 alpha-2 (lowercase 2-letter country code).
$filter = array(new \Tyre24\Common\Model\\Tyre24\Common\Model\GetAvailableArticleTypesListFilterParameterInner()); // \Tyre24\Common\Model\GetAvailableArticleTypesListFilterParameterInner[]
$accept_language = de_DE; // string | ISO 639-1 standard language codes. As default, even for invalid values, de_DE will be used!

try {
    $result = $apiInstance->getAvailableArticleTypesList($country, $filter, $accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ArticlesApi->getAvailableArticleTypesList: ', $e->getMessage(), PHP_EOL;
}

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

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:

composer install
vendor/bin/phpunit

Author

info@alzura.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1
    • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen