kruegge82's packages

• PHP

  kruegge82/afterbuy-sdk

  The AfterbuySDK provides to interact with the Afterbuy XML API

  10 0

• PHP

  kruegge82/billbee-php-sdk-api

  Documentation of the Billbee REST API to connect a Billbee account to external aplications. ## Endpoint The Billbee API endpoint base url is https://api.billbee.io/api/v1 ## Activation You have to enable the API in the settings of your Billbee account. In addition you need a Billbee API Key identifying the application you develop. To get an API key, send a mail to support@billbee.io and send us a short note about what you are building. ## Authorization & security Because you can access private data with the Billbee API, every request has to be sent over https and must * Contain a valid API Key identifying the application/developer. It has to be sent as the HTTP header X-Billbee-Api-Key * Contain a valid user login with billbee username and api password in form of a basic auth HTTP header ## Throttling 50 calls per second for each API Key. 10 calls per second for each API Key in combination with Billbee user. Besides that each endpoint has a throttle of max 2 requests per second per combination of API Key and Billbee user. When you exceed the throttle threshold, the API will return a HTTP 429 status code and a Retry-After-Header indicating how many seconds you will have to wait before you can call the API again.

  22 0

• PHP

  kruegge82/deutschepost-internetmarke-php-sdk

  Division: Post & Parcel Germany<br /> The INTERNETMARKE is the online-postage for mail products of Deutsche Post AG.

  34 0

• PHP

  kruegge82/dhl-authentication-oauth-api

  This API describes how API client can obtain a token which is used to access various Parcel Germany APIs. Using this API is often the first step in making your API call. <p><h3>Preconditions</h3> You will need: * client ID (aka "API Key", obtained when you create an app in developer.dhl.com) * client secret (obtained when you create an app in developer.dhl.com) * GKP user name (obtained when setting up your business account with Parcel Germany) * GKP password (obtained when setting up your business account with Parcel Germany) <h3>Technical Information</h3> This uses an implementation of OAuth2 Password Grant (RFC 6749). After successfull usage you will: * have an opaque access token to be used for API calls afterwards * this token will have an expiration time

  16 0

• PHP

  kruegge82/dhl-php-rest-sdk

  Note: This is the specification of the DPDHL Group Parcel DE Shipping API for Post & Parcel Germany. This REST web service allows business customers to create shipping labels on demand.

  47 1

• PHP

  kruegge82/dpd-php-sdk

  Library to interface with the DPD web services germany

  40 0

• PHP

  kruegge82/jtlffn

  # Introduction JTL-FFN is a standardized interface for fulfillment service providers and their customers. Fulfiller can offer their services to merchants and merchants can respectively choose from a wide range of service providers according to their needs. ## The ecosystem The FFN network consists of this REST API, an online portal and third party integrations (JTL-Wawi being one of them). The REST API orchestrates the interactions between the participants and the portal website provides services by JTL (such as managing and certifying warehouses of a fulfiller and merchants searching for their service providers). ## About this API The base url of this api is [https://ffn2.api.jtl-software.com/api](https://ffn2.api.jtl-software.com/api). This API (and this documentation) consists of three parts: * Fulfiller API - operations used when acting as a fulfiller in the network. Only users with the role `Fulfiller` can access these endpoints. * Merchant API - operations used when acting as a merchant in the network. Only users with the role `Merchant` can access these endpoints. * Shared API - operations available to all users. Please use the navigation menu at the top to switch between the documentation for the different APIs. # OAuth The FFN-API uses [OAuth2](https://tools.ietf.org/html/rfc6749) with the [Authorization Code Grant](https://tools.ietf.org/html/rfc6749#section-4.1) for its endpoints. Users must have an active [JTL customer center](https://kundencenter.jtl-software.de) account to authorize against the OAuth2 server. Applications and services using the API must acquire client credentials from JTL. ## Application credentials When making calls against the API, you need to do it in the context of an application. You will get the credentials for your application from JTL. Application credentials consist of the following: * `client_id` - uniquely identifies your application * `client_secret` - secret used to authenticate your application * `callback_uri` - the uri the OAuth2 server redirect to on authorization requests ## Requesting authorization When you want to authorize a user you redirect him to `https://oauth2.api.jtl-software.com/authorize` with the following query string parameters: * `response_type` - Must be set to "code" for the [Authorization Code Grant](https://tools.ietf.org/html/rfc6749#section-4.1). * `redirect_uri` - After the user accepts your authorization request this is the url that will be redirected to. It must match the `callback_uri` in your client credentials. * `client_id` - Your applications identifier from your application credentials. * `scope` - The scopes you wish to authorize (space delimited). * `state` - An opaque value that will be included when redirecting back after the user accepts the authorisation. This is not required, but is important for [security considerations](http://www.thread-safe.com/2014/05/the-correct-use-of-state-parameter-in.html). After successful authorization by the user, the OAuth2 server will redirect back to your applications callback with the following query string parameters: * `code` - The authorization code. * `state` - The state parameter that was sent in the request. ## Verifying authorization The authorization code you acquired in the last step will now be exchanged for an access token. In order to do this you need to POST a request to `https://oauth2.api.jtl-software.com/token`. >POST <https://oauth2.api.jtl-software.com/token> > >Authorization: Basic `application_basic_auth`\ >Content-Type: application/x-www-form-urlencoded > >grant_type=authorization_code&code=`code`&redirect_uri=`redirect_uri` In the Authorization header [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is used. Your application credentials `client_id` will be used as the username and your `client_secret` as the password. The header should have the value "Basic" plus the Base64 encoded string comprising of `client_id:client_secret`. The body of the request consist of the form encoded parameters: * `grant_type` - Must be set to "authorization_code". * `code` - The authorization code received from the previous step. * `redirect_uri` - Must match the `callback_uri` in your client credentials. A successful verification request will return a JSON response with the properties: * `token_type` - is always "Bearer" * `expires_in` - the time in seconds until the access token will expire * `access_token` - the access token used for API requests * `refresh_token` - token used to get a new access_token without needing to ask the user again Now the APIs endpoints that need authorization can be called by setting the header >Authorization: Bearer `access_token` ## Refreshing authorization To get a new `access_token` (for example when the old one expired) one can POST a request to `https://oauth2.api.jtl-software.com/token`. >POST <https://oauth2.api.jtl-software.com/token> > >Authorization: Basic `application_basic_auth`\ >Content-Type: application/x-www-form-urlencoded > >grant_type=refresh_token&refresh_token=`refresh_token` The Basic HTTP Authorization works exactly as in the verification step. The body of the request consist of the form encoded parameters: * `grant_type` - Must be set to "refresh_token". * `refresh_token` - The `refresh_token` you acquired during verification. The response will be the same as in the verification step. ## Scopes Scopes allow fine grained control over what actions are allowed for a given application. During login users must approve the requested scopes, so it is often feasible to limit asking for permissions your application really needs. Global scopes for common permission scenarios are the following: * `ffn.fulfiller.read` - full read access for the fulfiller API * `ffn.fulfiller.write` - full write access for the fulfiller API * `ffn.merchant.read` - full read access for the merchant API * `ffn.merchant.write` - full write access for the merchant API More fine grained scopes can be acquired from each respective endpoints documentation. ## Example ### Prerequsites * JTL Customer center account (https://kundencenter.jtl-software.de/) * cUrl (https://curl.se/) * FFN portal account (just login here: https://fulfillment.jtl-software.com) * FFN portal sandbox account (if you want to test on sandbox: https://fulfillment-sandbox.jtl-software.com) * Oauth Client for authorization and define scopes Values in this example (access_token, refresh_token, code...) are expired and cannot be used verbatim. ### Step 1 - Create an OAuth client Navigate to https://kundencenter.jtl-software.de/oauth and create a new OAuth client. (You can´t navigate to Oauth in customer account, you should use this link, or you can change logged in index to oauth) !Templates define what scopes are possible for this client. scopes with access rights: * ffn.merchant.read - full read access for the fulfiller API * ffn.merchant.write - full write access for the fulfiller API * ffn.fulfiller.read - full read access for the merchant API * ffn.fulfiller.write - full write access for the merchant API More fine grained scopes can be acquired from each respective endpoints documentation.  Overview: clients, scopes, client-secret and client-id  In our example: * client_id: 97170e65-d390-4633-ba46-d6ghef8222de * client_secret: f364ldUw3wGJFGn3JXE2NpGdCvUSMlmK72gsYg1z * redirect_uri: http://localhost:53972/ffn/sso The values for this client should not be used in production and are for testing only. ### Step 2 - User login In this step you will redirect the user to the JTL OAuth website using his default browser. Here the user will provide his username/password and accept the requested scopes. Finally the JTL Oauth website will redirect to the provided redirect_uri and provide the code. Template: authorize specified scopes and get code answer to request the access token ``` https://oauth2.api.jtl-software.com/authorize?response_type=code&redirect_uri=[redirect_uri]&client_id=[client_id]&scope=[scopes] ``` Note: the scopes should be seperated by spaces or %20 Filled with our example values: ``` https://oauth2.api.jtl-software.com/authorize?response_type=code&redirect_uri=http://localhost:53972/ffn/sso/oauth&client_id=97170e65-d390-4633-ba46-d6ghef8222de&scope=ffn.merchant.read%20ffn.merchant.write ``` * enter password  * authorize scopes  * code answer from server  Example of the answer from the OAuth server to our redirect_uri: ``` http://localhost:53972/ffn/sso?code=def50200f3ac7aabbb6e82a6b131874115b858549dab62e73c68ea21a03de59b5744dc0f0ee321d7607062cf9bfa57471cd0ee7572db1d7b0a15779b0dda7d0ed8f8bfdb0f69939a34678d67aee41e4849d355d8aa223733ab1f397280b205fa739c6252d77d9ff600136e1b744352115fd62ba1035d8da4cbc1b6791c61d0bb621952b0a14625dd75807113ea0746e35528c304a8ce3c06724c1e1d9e1cb3709e9f52778bc8ca5b2d8f7c055f14244b1f8fcb61554c5bf48e02b882b87b9a76a43579eecd578cec97c6f603907e282e45cfec43837c063dc36b556d4974776a942f47cee19023e130ae852bfca6d3ca9c7cb3283d2bc4971f80651b626f8e7ba0ec2d13dddc4c528e1f3e470de907af7eb304d781534dd9b071d9760c9890e5756893c7800589c407bd2da3a2ff56c3fb15a410e24aa2df7ac54e8d0f7445e38e390171b58a0b66b337057d59acd29ed5bbc4df6bee921b244f030c86f49bcae21c9ca77c05eea0094414803f30089c39d585bf83604a2d9bbcc6442fbfdcff6cca946eb84d1eac2e4f98dff31a93460c951c853f9ef7140f572be963e82a3baf72afba34572af63ee7da ``` Extract the code and note it for next steps. ### Step 3 - Get an access_token from the code Template: get access token + refresh token ``` curl --location --request POST "https://oauth2.api.jtl-software.com/token" --header "Content-Type: application/x-www-form-urlencoded" -u "[client_id]:[client_secret]" --data-urlencode "grant_type=authorization_code" --data-urlencode "redirect_uri=[redirect_uri]" --data-urlencode "code=[code]" ``` Filled with our example values: ``` curl --location --request POST "https://oauth2.api.jtl-software.com/token" --header "Content-Type: application/x-www-form-urlencoded" -u "97170e64-d390-4696-ba46-d6fcef8207de:f364ldUw3wIJFGn3JXE2NpGdAvUSMlmK72gsYg1z" --data-urlencode "grant_type=authorization_code" --data-urlencode "redirect_uri=http://localhost:49420/oauth" --data-urlencode "code=def50200e6f3c65cfaba9419cbf6e48a7ed4324ef851b0ace493213884496b851fd825b90b4f994ee265a62f2358bbcbb0f990af5dbfd93dc63e51a7a6fa3bcfc7f722f56366b0a726fd1ed5df1cb926b16610fc7beb0f236e8858e86397422e3caa75d8094af8ba8ad6a93b938bd341bec1e4df671ad71ad1d5fa41166f5d4b2a3ac7d9172c35a8501f10ad722ec2aea88439c21b148ec2ba85e93c17acebe7d7f3d0118a50941cab145ed5ce92946426e5d388584556c0b010c567b433c577a1c4f7b1dfb2c99c25a0efadece4f64f19e54305bfc591e2b30b1a7ba1a33af3e039bcfa80b21ca365dc003f07989fca92472c2c8e2daab51151624a6a10bc511f2ed586f06544f7b98566df4667f5bbd6ba7c6707cb673c767c9eab5a74e63a8269688941c3158e8cc1cb5ebe9a8aa468faf415171a481ee1489b58bedb5fc329b23e0e34e76a4a500270fbebe4e1d20a0f17cebc96cd8ab3db383af746ca0699da34b4665afad30e9dde4f5f507a1dd14c73a692f06de8bafe3be81d7744dbcd8c5f7d3c767101ff5ce0556c244130c1c3fc3f53975a841c0cacebb70118f7552f50c2d2b1c421b8a21e" ``` The result will be a JSON answer with the users access_token and refresh_token as well as the expiry in seconds. ``` { "token_type":"Bearer", "expires_in":1800, "access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9. eyJhdWQiOiI5NzE3MGU2NC1kMzkwLTQ2OTYtYmE0Ni1kNmZjZWY4MjA3ZGUiLCJqdGkiOiJlOWVhN2Q0MWI1NDIzNTcyYWU0MDEzYjEzMDZiMGRkNWM3YmQ2ZTNjMDNhYTZmNjQ2M2NlMjUzNTc0ZmUyMWE3NGQyNTIyMTJhODQwMmI1ZCIsImlhdCI6MTY2MTI1MzE0OCwibmJmIjoxNjYxMjUzMTQ4LCJleHAiOjE2NjEyNTQ5NDgsInN1YiI6IjQ2MjA5Iiwic2NvcGVzIjpbImZmbi5tZXJjaGFudC5yZWFkIiwiZmZuLm1lcmNoYW50LndyaXRlIl19.eEwY021wR3BWVp-wbAVQrjfqwFbYqLlOV_ca-cb7-O3Kdpi8mkFQBxfI8rzSiV_1WpAINf4ydV9FR9Ty992SMiAqGJ3T9zDHd68oUDePeq7Xfafp-87UboI2mCfGd7518CoKVLqg5ohb4YCqgC7Dz588FofggCQyDZQSM-8raOgcM-pJ1TT7oRuYuDHsOzCOTPcX2YiGYKCc3M6kxlBy_NjrJoLa4qysLRmPkznWwj0caC7a0VJO5KubvECcMb9D7Byr3UNjI7GiGMAufa770V5qCjrWs4gOsRV-Bn7oQydvsL21qqjBKHcssQrlLZWmrcfKqgBKwfRXIx3Mu5HBCmtHjHMnuvPVEZAj6fEfIwjYSeTAHTHApEwbE7J1MPd8MU0K6X2YEUF315fXN5F3rO3ZL5FdTwcM1E-1-PKubLuMAaE6Lw-QsDtBoI4ESylomCmCCfgLV4Vj-in_oCJUmKXAX0tDSa9y9vb6oAExung_BTJCBemffCtkJ55Px7bvi9JXmwvI0pIFo3QzTUtRbFDizCMrPZvsatFx64mXX3IDoVqXr3uzvdetBIJEj2ngVdGRrKGt4Yboae5oFV2d5jdSZBL28pwGjey__ZB4zLR1DodQ0sOqDWJ3WsEjMYXU8_-IGrS8Kkw8Q0R0UqqyVLfcLr-cfH5tYqf2QLqAScY","refresh_token":"def50200e636703f8d6372401e7b5e1163e0f46e5d593f6f8a1e9b1b2777d64684b87b7c552db62f9670bc482a3958d8aafb78083c7166c13f2f233fe4623d22873c819a560dc3213a51448a1e0763c2a0f7fb7230ceeae22a7fa84717458886584ab5a0ed1a500be5f9d3ed36b1d063d39b56c8431f3fe623055626c1f99f8c5b684853965645fe5c5bee941857aef79ae4f9b994316bec9d365119fe0fe8d035218c44d00a47c0e92b4613c1f388b9c171f3d79e45a6d2a52dfbd8d25608d6b0350420155e48cc179764a2432220cc0d1e9bfa7798050d0b36fe658e967186ea75cc1d1277cad973d43a0839c50b6885a87b5b446452855a00ac75c5f6d7f62b914496e30ab89a16b335977e4363b94dda7364bb052832a5d122696b6476fb0e1631030ea3c42d9659ca839cc44919efc9532c84f7170e634d3e189eb181d0c114ed9d8150c619f7567587e0311d89d51d1325646d2c014757ba7f2d7b02f7b56a52e093ed2ea95a8abe4a0289b24a5636dce8ad01c20e8cce8c4c51263e7f1731bb6335b0e31342e2439c77ab7cce7a147e24c9be9d61d8eba216fbfd4d5be2fba3502e69000ad6e67b7230a7f924" } ``` ### Step 4 - Test the access_token Using your newly aquired access_token you can test if its working (reminder: the access_token has a limited lifetime and might be expired, in which case we would need to refresh it (see Step 5)). Template: Test communication with access token on sandbox or production (our client is for both systems) ``` curl --location --request GET "https://ffn-sbx.api.jtl-software.com/api/v1/users/current" --header "Authorization: Bearer [access_token]" ``` If you cannot retrieve the user data using this endpoint make sure you have logged into our respective portal website (sandbox, production) at least once as this triggers user creation in the system. ### Step 5 - Refresh access_token when it expires Template: Get a new access token + refresh token with the refresh token ``` curl --location --request POST "https://oauth2.api.jtl-software.com/token" --header "Content-Type: application/x-www-form-urlencoded" -u "[client_id]:[client_secret]" --data-urlencode "grant_type=refresh_token" --data-urlencode "refresh_token=[refresh_token]" ``` Filled with our example values: ``` curl --location --request POST "https://oauth2.api.jtl-software.com/token" --header "Content-Type: application/x-www-form-urlencoded" -u "97170e64-d390-4696-ba46-d6fcef8207de:f364ldUw3wIJFGn3JXE2NpGdAvUSMlmK72gsYg1z" --data-urlencode "grant_type=refresh_token" --data-urlencode "refresh_token=def50200a01c0caff50b7db271f8268e3806ab2cce8e28e25f41e5fe9167a6521b47f6ed0dd3dd2d7856e1983ae645b032cf9285e91c1ee535decb0e0ca3e52670773f2737114955267d83db0204f80233214a623fcc36de04127e1cdcda006eaf60cacfb30c80081a8c9314e20117f64639ab5e333301a10173385c1bfc660709fde0b1a3517f8030dfdba8187e53c23c9d5fe9f33c48e11a4aa41bfd9ea1291507ea1bc8c64df32bdc91c61af907c41cf0bb305cae76e68448a85ad65b0a03a23ec35a7e9cc42aadd0792b9d7d187ae028e2759a7f4a0164f94d9baca29779a702f023216631e1e777069cc2bc65fd404f4fcc5818219063beb1717afe159b8110394af9a0d245de960c227b1183d6a745819ac08d92238938da798f702f83a3faf648f07a8a6d1e694c008517fd8be2fa154aab88a3eaacb3cbb1830c4bdee018e06c7f81e68c5844213f1d02372b23a22d99ac06a860748a3db891fd71768d74470c9a5a8571058dd901c888d13cd4481d63a800322614e63d3d8e6fb109ee7e1b1e046cd086ecbc2d4d362ca662e3ac867f21168833abd7a8247b06602197b7da555361efbf07b0afed69f7a558" ``` The result will be the same format as in step 3. Refresh_tokens are only valid for a single refresh and you will get a new refresh_token every single time that you must persist. ### My token is not working! #### 404 NotFound You need to log into the respective portal website (sandbox-https://fulfillment-sandbox.jtl-software.com, production-https://fulfillment.jtl-software.com) at least once to trigger user creation. #### 403 Forbidden You might be missing scopes in your token and don't have sufficient rights. #### 401 Forbidden Incorrect Oauth method. For example, we do not support the Oauth method authorisation "client_credentials grant". The authorisation method "code grant" with user must be used.

  2 0

• PHP

  kruegge82/shipstage-php-sdk

  Wenn Sie die API verwenden möchten, wenden Sie sich bitte an den Support, um ein Authentifizierungstoken zu erhalten.

  8 0

• PHP

  kruegge82/weclapp

  # Getting Started API Version: [v1](v1.html) The weclapp REST API lets you integrate weclapp with other applications or services. The specification for this version can be downloaded here: | Format | Public | |---------------------------------|----------------------------------------------------------------------------------| | swagger JSON | <a href="swagger.json" download="weclapp-swagger.json">Download</a> | | OpenApi 3 JSON | <a href="openapi_v2.json" download="weclapp-openapi.json">Download</a> | | OpenApi 3 YAML (with user docs) | <a href="openapi_v2.yaml" download="weclapp-openapi.yaml">Download</a> | ## What should I know before starting? Our API is continuously being developed and improved, but we are still trying to keep it as stable as possible. We try to only have changes that are backwards compatible: usually the changes are only additions, e.g. new resources are implemented or new properties are added to existing resources. Sometimes breaking changes cannot be avoided, e.g. when a new feature requires an incompatible change to the underlying data model, all those changes will be documented in the change log. ## Security and Authentication You must be a verified user to make API requests. You can authorize against the API with an API token. The token is configurable in your weclapp account under **My settings > API**. Authentication is possible in multiple ways: If the request contains the session cookies of a logged in weclapp session then the user and permissions of that session are used. This is useful when testing the API in a web browser, because then requests are “automatically” authenticated if weclapp is used in another tab. But generally the API is not used from a browser or with session cookies, instead there is an API token for each user that can be used to authenticate requests. Each user can find his/her token on the "My Settings page". The token should be kept secret like a password. A user can also generate a new token at any time, doing that invalidates all previous tokens. Authenticating using a token is possible in two ways: * the token can be sent using the AuthenticationToken header `AuthenticationToken: {api_token}` * the standard HTTP Basic authentication can be used: the username needs to be `“*”` and the password is the token ## Using curl ```bash curl --compressed -H "AuthenticationToken:{api_token}" "https://<TENANT>.weclapp.com/webapp/api/v2" ... ``` Examples of how to use curl will be shown in each section of this API. ## Headers This is a JSON-only API. You must supply a `Content-Type: application/json` header on PUT and POST operations. You must set a `Accept: application/json` header on all requests. You may get a `text/plain` response in case of error, e.g. in case of a bad request, you should treat this as an error you need to take action on. To reduce traffic the weclapp API works with [compression](https://developer.mozilla.org/en-US/docs/Web/HTTP/Compression#end-to-end_compression). This means, a client should always submit the header “Accept-Encoding: gzip”. If this header is not set, the API will enforce compression and respond with "Content-Encoding: gzip". Please also make sure to set a `User-Agent` header for all automated requests, as that makes it much easier to identify misbehaving clients. ## URLs The base URL for the API is `https://<TENANT>.weclapp.com/webapp/api/v2/` where `<TENANT>.weclapp.com` is the domain of the specific weclapp instance. So each weclapp instance has its own API endpoints which allow accessing data for that particular instance. The API provides access to various resources like customers, sales orders, articles etc.. Each of those resources implements a common set of operations. The URLs and HTTP methods for the different resource operations use the same pattern for all resources: | Operation | HTTP Method | URL pattern | |-------------------------------|-------------|-----------------------------------------------------------------------| | Query/list instances | GET | `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>` | | total number of instances | GET | `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>/count` | | Get a specific instance by id | GET | `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>/id/<id>` | | Create a new instance | POST | `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>` | | Update a specific instance | PUT | `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>/id/<id>` | | Delete a specific instance | DELETE | `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>/id/<id>` | Not all resources support all of those operations. A general description for each operation can be found in API operations by example, and details for each resource are described on the page for that resource. ## Additional operations Some resources allow further operations or actions. Those operations can be executed with a POST request, for some operations that only read data it is also possible to use a GET request (this is documented for each operation). For general operations for a resource the URL pattern is `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>/<operation>`. Some operations are instance specific, those use the following URL pattern: `https://<TENANT>.weclapp.com/webapp/api/v2/<resource>/id/<id>/<operation>`. ## JSON | Type | Representation in JSON | |----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | string | Serialized as JSON string, empty strings (length 0 or only whitespace) are always interpreted as null, it is not possible to have a property with an empty string value. | | boolean | Serialized as `true` / `false`. | | decimal number | Most numbers in weclapp are decimal numbers with a fixed precision and scale (e.g. quantities or prices), they are serialized as JSON strings and not as JSON numbers to prevent accidental loss of precision when the JSON is deserialized with a JSON library that uses doubles to represent JSON numbers. The serialized numbers always use a “.” as the decimal mark (if one is required). | | integers | Integer numbers (that can safely be represented as a double) are serialized as JSON numbers. | | floats/doubles | Serialized as JSON numbers. | | dates and timestamps | Serialized as the milliseconds since 1970-01-01T00:00:00Z (as a JSON number). | | enums | Sometimes a property value can be one of a fixed number of named options. Those enum properties are serialized as a JSON string with the name of the option. | The deserialization of data sent to the API is relatively lenient, for example when a string is expected, but a number is given then that number is used as the string and the other way around (if possible). Properties with the value null are not serialized by default and when sending data to the API it is also not necessary to include properties whose value is null: all properties that are missing from the JSON object but are expected are assumed to be `null`. To get all properties including those with the value null the query parameter `serializeNulls` can be added to the request URL, in that case null values are included in the response. ## Error Responses Any request on the weclapp API may return an error response, with a structure conforming to [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). See the [API error reference](#errors) section for details. ## Change Policy weclapp may modify the attributes and resources available to the API and our policies related to access and use of the API from time to time without advance notice. weclapp will use commercially reasonable efforts to notify you of any modifications to the API or policies through notifications or posts on the weclapp Developer Website. weclapp also tracks deprecation of attributes of the API on its Changelog. Modification of the API may have an adverse effect on weclapp Applications, including but not limited to changing the manner in which weclapp Applications communicate with the API and display or transmit Your Data. weclapp will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications # API newsletter Sign up here for our [API newsletter](https://340d89eb.sibforms.com/serve/MUIEAEREP3buQMWpwPwuVohmsPBikdVQIilNQeZ2DJBE5NZePFYqyp_62WSheCC5t_Q7eJ6SVpZBauqRY93L8L8Iquik5gaH40Bi0uOtPioS7U7k4JvemqVuSdvEV0A3DgygC5LOAv-kjuN4Ij5MUqzm5DSHYbmKvGucHMXpZMFGGA5Lwi5VUv6ZZbROGqZJCrGfYFxGttzVBqc_). We will inform you regularly about planned API changes. # API operations sample As mentioned previously all resources implement common operations in the same way. In the following all the common operations are explained for the `customer` resource. The operations work in the same way for all other resources (some resources don’t support all the operations), the differences between the resources are mostly the data and the properties that are required and used. ## Querying The most common operation is querying or listing the existing entity instances. This is possible with a `GET` request to the base URL of a resource: ### `GET /customer` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer" ``` **Output:** ```json { "result": [ { "id": "4342", "version": "1", "addresses": [ { "id": "4344", "version": "0", "city": "München", "countryCode": "DE", "createdDate": 1496828973904, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1496828973903, "primeAddress": true, "street1": "Mustergasse 7", "zipcode": "80331 " } ], "blocked": false, "company": "Muster GmbH", "contacts": [ { "id": "4332", "version": "1", "addresses": [ { "id": "4334", "version": "0", "city": "München", "countryCode": "DE", "createdDate": 1496828882836, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1496828882836, "primeAddress": true, "street1": "Fasanenweg 15", "zipcode": "80331" } ], "createdDate": 1496828882837, "email": "mustermann@beispiel.de", "firstName": "Max", "lastModifiedDate": 1496828996245, "lastName": "Mustermann", "partyType": "PERSON", "personCompany": "Muster GmbH", "salutation": "MR" } ], "createdDate": 1496828973904, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048" } ], "customerNumber": "C1006", "customerTopics": [], "deliveryBlock": false, "insolvent": false, "insured": false, "lastModifiedDate": 1496828996212, "optIn": false, "partyType": "ORGANIZATION", "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "sales@weclapp.com", "salesChannel": "NET1", "useCustomsTariffNumber": false } ] } ``` In this case there is one sales order with one order item. By default, all null values are omitted, to include them the query parameter serializeNulls can be used: ### `GET /customer?serializeNulls` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?serializeNulls" ``` **Output:** ```json { "result": [ { "id": "4342", "version": "1", "addresses": [ { "id": "4344", "version": "0", "city": "München", "company": null, "company2": null, "countryCode": "DE", "createdDate": 1496828973904, "deliveryAddress": false, "globalLocationNumber": null, "invoiceAddress": false, "lastModifiedDate": 1496828973903, "postOfficeBoxCity": null, "postOfficeBoxNumber": null, "postOfficeBoxZipCode": null, "primeAddress": true, "state": null, "street1": "Mustergasse 7", "street2": null, "zipcode": "80331 " } ], "amountInsured": null, "annualRevenue": null, "birthDate": null, "blockNotice": null, "blocked": false, "commercialLanguageId": null, "company": "Muster GmbH", "company2": null, "contacts": [ { "id": "4332", "version": "1", "addresses": [ { "id": "4334", "version": "0", "city": "München", "company": null, "company2": null, "countryCode": "DE", "createdDate": 1496828882836, "deliveryAddress": false, "globalLocationNumber": null, "invoiceAddress": false, "lastModifiedDate": 1496828882836, "postOfficeBoxCity": null, "postOfficeBoxNumber": null, "postOfficeBoxZipCode": null, "primeAddress": true, "state": null, "street1": "Fasanenweg 15", "street2": null, "zipcode": "80331" } ], "birthDate": null, "company": null, "company2": null, "createdDate": 1496828882837, "customAttributes": null, "description": null, "email": "mustermann@beispiel.de", "fax": null, "firstName": "Max", "fixPhone2": null, "lastModifiedDate": 1496828996245, "lastName": "Mustermann", "middleName": null, "mobilePhone1": null, "mobilePhone2": null, "partyType": "PERSON", "personCompany": "Muster GmbH", "personDepartment": null, "personRole": null, "phone": null, "phoneHome": null, "salutation": "MR", "title": null, "website": null } ], "createdDate": 1496828973904, "creditLimit": null, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048", "booleanValue": null, "dateValue": null, "numberValue": null, "selectedValueId": null, "selectedValues": null, "stringValue": null } ], "customerCategoryId": null, "customerCategoryName": null, "customerNumber": "C1006", "customerRating": null, "customerTopics": [], "defaultHeaderDiscount": null, "defaultHeaderSurcharge": null, "deliveryBlock": false, "description": null, "email": null, "fax": null, "firstName": null, "insolvent": false, "insured": false, "invoiceContactId": null, "lastModifiedDate": 1496828996212, "lastName": null, "leadSourceId": null, "leadSourceName": null, "middleName": null, "mobilePhone1": null, "oldCustomerNumber": null, "optIn": false, "parentPartyId": null, "partyType": "ORGANIZATION", "paymentMethodId": null, "paymentMethodName": null, "personCompany": null, "personDepartment": null, "personRole": null, "phone": null, "primaryContactId": null, "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "sales@weclapp.com", "salesChannel": "NET1", "salutation": null, "satisfaction": null, "sectorId": null, "sectorName": null, "shipmentMethodId": null, "shipmentMethodName": null, "termOfPaymentId": null, "termOfPaymentName": null, "title": null, "useCustomsTariffNumber": false, "vatRegistrationNumber": null, "website": null } ] } ``` ## Pagination By default the operation will not return all entity instances but only the first 100, this can be changed by using the `pageSize` query parameter with the number of desired results. But `pageSize` cannot be arbitrarily high it is usually limited 1000 (exceptions to the default limits of 100 and 1000 are noted in the documentation for the specific resources). To get further results it is necessary to skip entity instances, this is done using the `page` query parameter. Examples: ### `GET /customer?pageSize=10` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?pageSize=10" ``` returns at most 10 instances ### `GET /customer?page=2&pageSize=10` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?page=2&pageSize=10" ``` returns the second page of results (the `page` parameter is one based, so `page=1` is the first page, which is also the default). Using those two parameters it is possible to implement pagination. ## Sorting It is also possible to change the order of the returned results using the `sort` parameter: ### `GET /customer?sort=lastModifiedDate` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?sort=lastModifiedDate" ``` sort by `lastModifiedDate` (ascending). ### `GET /customer?sort=-lastModifiedDate` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?sort=-lastModifiedDate" ``` sort by `lastModifiedDate` descending. ### `GET /customer?sort=lastModifiedDate,-salesChannel` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?sort=lastModifiedDate,-salesChannel" ``` sort by `lastModifiedDate` (ascending) and then `salesChannel` descending. It is generally possible to sort by most of the simple properties of an entity. It is possible to combine multiple sort orders by combining the property names with a comma. To sort in descending order just prepend a minus to the property name. If an unsupported or unknown property is specified then an error response is returned. ## Filtering It is often desired to get just a subset of the data, for example just the orders of a specific customer or created after a specific date. This is possible using filtering query parameters: ### `GET /customer?salesChannel-eq=NET1` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?salesChannel-eq=NET1" ``` customers for `salesChannel` `NET1`. ### `GET /customer?createdDate-gt=1398436281262` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?createdDate-gt=1398436281262" ``` customers created after the specified timestamp. ### `GET /customer?salesChannel-eq=NET1&createdDate-gt=1398436281262` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?salesChannel-eq=NET1&createdDate-gt=1398436281262" ``` customers for `salesChannel` `NET1` and created after the specified timestamp. ### `GET /customer?customAttribute4587-eq=NEW` ```bash curl --compressed -H """AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?customAttribute4587-eq=NEW" ``` customers with the value `NEW` for `customAttribute` with id 4587. ### `GET /customer?customAttribute4587.entityReferences.entityId-eq=1234` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer?customAttribute4587.entityReferences.entityId-eq=1234" ``` customers with an entity reference to an entity with the id 1234 for the `customAttribute` with the id 4587. ### `GET /customAttributeDefinitions` All attributeTypes are supported except `MULTISELECT_LIST`. CustomAttributes of attributeType `LIST` could be filtered by `customAttribute{customAttributeId}.id` or `customAttribute{customAttributeId}.value`. ### `GET /customer?customAttribute3387.value-eq=OPTION1` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?customAttribute3387.value-eq=OPTION1" ``` customers with value `OPTION1` for `customAttribute` with id 3387. A filtering query parameter consists of a property name and a filter operator joined together with a minus. If multiple filtering query parameter are specified then they are combined and the returned results match all of them. Filtering query parameters for unknown properties or properties that don’t support filtering are silently ignored. The following filtering operators are supported (not all of them work for all property types): | Operator | Meaning | |----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | eq | equal | | ne | not equal | | lt | less than | | gt | greater than | | le | less equal | | ge | greater equal | | null | property is null (the query parameter value is ignored and can be omitted) | | notnull | property is not null (the query parameter value is ignored and can be omitted) | | like | like expression (supports `%` and `_` as placeholders, similar to SQL LIKE) | | notlike | not like expression | | ilike | like expression, ignoring case | | notilike | not like expression, ignoring case | | in | the property value is in the specified list of values, the query parameter value must be a JSON array with the values in the correct type, for example `?customerNumber-in=["1006","1007"]` | | notin | the property value is not in the specified list of values | ## "Or" condition filtering In addition to the default behavior of linking filter expressions via "and" you can also link individual filter expressions via "or" by prefixing their parameter name with "or-": ### `GET /customer?or-name-eq=charlie&or-name-eq=chaplin` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?or-name-eq=charlie&or-name-eq=chaplin" ``` The above example is the equivalent of the expression `(name equals "charlie") or (name equals "chaplin")` For combining `or` and `and` clauses you may also group `or` expressions by using `or<groupname>-` instead of the plain `or-` prefix: ### `GET /customer?orGroup1-name-eq=charlie&orGroup1-name-eq=chaplin&orGroup2-responsibleUserUsername-eq=mrtest&orGroup2-referenceNumber=4711&commercialLanguageId-eq=12` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?orGroup1-name-eq=charlie&orGroup1-name-eq=chaplin&orGroup2-responsibleUserUsername-eq=mrtest&orGroup2-referenceNumber=4711&commercialLanguageId-eq=12" ``` The above example is the equivalent of the expression ``` ((name equals charlie) or (name equals chaplin)) and ((responsibleUserUsername equals "mrtest") or (referenceNumber equals "4711")) and (commercialLanguageId equals "12") ``` Technically, the default "or-" variant is just a special case of this, using the empty String as group name. ## Filter Expressions **Warning: This is still a beta feature.** In addition to individual filter properties it is also possible to specify complex filter expressions that can combine multiple conditions and express relations between properties. Example: ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ https://<TENANT>.weclapp.com/webapp/api/v2/party \ --get \ --data-urlencode 'filter=(lower(contacts.firstName + " " + contacts.lastName) = "Ertan Özdil") and (lastModifiedDate >= "2022-01-01T00:00:00Z")' ``` * "filter" parameters are ANDed with other filter parameters * Property references in filter expressions have exactly the same form and semantics as for the individual filter parameters. * Multiple "filter" parameters may be used if needed. ### Examples Some more example filter expressions: ```sql -- enum literals are specified as string literals (salesChannel in ["NET1", "NET4", "NET5"]) and (partyType = "ORGANIZATION") -- normal arithmetic operations are supported. (unitPrice + unitPrice * salesTax) <= 49.99 -- elementary functions length(trim(notes)) <= 140 -- conditions can be combined with logical operators (not (contacts.firstName null)) or (currencyId = 4711) ``` ### Availabe Operations ### arihmetic | Operation | Operator(s) | Allowed Types (left operand) | Allowed Types (right operand) | Notes | |--------------------------|-------------------------|--------------------------------|---------------------------------|-----------------------| | addition | + | integer, float, string | integer, float, string | Addition of two numerical values or concatenation of two strings | | subtraction | - | integer, float | integer, float | | | multiplication | * | integer, float | integer, float | | | division | / | integer, float | integer, float | | | negation | - | --- | integer, float | | ### comparison | Operation | Operator(s) | Allowed Types (left operand) | Allowed Types (right operand) | Notes | |--------------------------|-------------------------|--------------------------------|---------------------------------|-----------------------| | equals | = | integer, float, string, boolean, date, enum | integer, float, string, boolean, date, enum | | | not equals | != | integer, float, string, boolean, date, enum | integer, float, string, boolean, date, enum | | | less than | < | integer, float, date | integer, float, date | | | greater than | > | integer, float, date | integer, float, date | | | Less than or equals | <= | integer, float, date | integer, float, date | | | Greater than or equals | >= | integer, float, date | integer, float, date | | | Pattern matching | ~ | string | string | Supports % and _ as placeholders, similar to SQL LIKE | | Alternatives match | in | integer, float, string, boolean, date, enum | list | Value is one of the given alternatives | | Property is null | null | integer, float, string, boolean, date, enum | --- | | ### logical | Operation | Operator(s) | Allowed Types (left operand) | Allowed Types (right operand) | Notes | |--------------------------|-------------------------|--------------------------------|---------------------------------|-----------------------| | and | and | boolean | boolean | | | or | or | boolean | boolean | | | not | not | --- | boolean | | ### function | Operation | Operator(s) | Allowed Types (left operand) | Allowed Types (right operand) | Notes | |--------------------------|-------------------------|--------------------------------|---------------------------------|-----------------------| | trim | trim | --- | string | Remove whitespace from both ends of a string | | length | length | --- | string | Get the number of characters in a string | | lower | lower | --- | string | Convert a string to lower case | ### Type Coercion Literals in the expression are interpreted as different types depending on their context: * An `integer` literal being compared to a `date` property is interpreted as milliseconds since Epoch * A `string` literal being compared to a `date` property is interpreted as [ISO-8601 point in time](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) with optional milliseconds and required time zone. Examples: * `2024-10-13T10:39:12+02:00` * `2024-10-13T10:39:12.443+02:00` * `2024-10-13T10:39:12Z` * `2024-10-13T10:39:12+02:00` * A `string` literal being compared to an `enum` property is interpreted as enum constant * ID properties (i.e. properties named `id` or `<something>Id`) can be compared to both integer and string literals ## Return only specific properties Sometimes it is desirable to only fetch a subset of all properties, for example to save bandwidth. This is possible by specifying the desired properties using the `properties` query parameter: ### `GET /customer?properties=id,customerNumber,salesChannel` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?properties=id,customerNumber,salesChannel" ``` **Output:** ```json { "result": [ { "id": "3346", "customerNumber": "C1002", "salesChannel": "NET1" } ] } ``` It is also possible to specify property paths: ### `GET /customer?properties=id,customerNumber,salesChannel,contacts.id,contacts.lastName` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer?properties=id,customerNumber,salesChannel,contacts.id,contacts.lastName" ``` If an unknown property or property path is specified then an error response is returned. ```json { "result": [ { "id": "3346", "contacts": [ { "id": "3731", "lastName": "Mustermann" } ], "customerNumber": "C1002", "salesChannel": "NET1" } ] } ``` ## Combinations The query parameters for pagination, sorting, filtering and returning only specific properties can be combined to perform queries. ## Counting To determine the total number of entity instances the count operation can be used: ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer/count" ``` It is possible to use the filtering query parameters from the querying operation with the count operation: ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/customer/count?salesChannel-eq=NET1" ``` returns the number of customers for `salesChannel` `NET1`. ## Referenced entities The API offers the possibility to get the referenced entities for a query result in the same request. This way you can save subsequent requests and get all necessary and referenced data in one request. This feature can be used by simply specifying the parameter `includeReferencedEntities` and the primary key references as comma separated list. The API response will contain an additional object `referencedEntities`. ### `GET /article?includeReferencedEntities=unitId,articleCategoryId` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/article?includeReferencedEntities=unitId,articleCategoryId&properties=id,name,unitId,articleCategoryId" ``` **Output:** ```json { "result": [ { "id": "3235", "name": "Testartikel 1", "unitId": "2770" }, { "id": "3236", "name": "Testartikel 2", "unitId": "2770" }, { "id": "3237", "articleCategoryId": "7035", "name": "Testartikel 3", "unitId": "2770" } ], "referencedEntities": { "unit": [ { "id": "2770", "version": "0", "createdDate": 1597915605986, "description": "Stück", "lastModifiedDate": 1597915605985, "name": "Stk." } ], "articleCategory": [ { "id": "7035", "version": "0", "createdDate": 1619778730348, "lastModifiedDate": 1619778730348, "name": "Demo-Gruppe" } ] } } ``` ## Additional properties In addition to the common properties, there are additional properties that can be optionally queried. These are calculated or complexly determined and must therefore be explicitly queried. To use this function, only the parameter `additionalProperties` and the names of the additional properties must be specified as a comma-separated list. The response then contains the additional object `additionalProperties` with the property and an array of values. The index of the value object in this list also represents the reference to the respective entity. ### `GET /article?additionalProperties=currentSalesPrice` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ "https://<TENANT>.weclapp.com/webapp/api/v2/article?additionalProperties=currentSalesPrice" ``` **Output:** ```json { "additionalProperties": { "currentSalesPrice": [ { "articleUnitPrice": "39.95", "currencyId": "256", "quantity": "1", "reductionAdditionItems": [] }, { "articleUnitPrice": "479.4", "currencyId": "256", "quantity": "1", "reductionAdditionItems": [] } ] } } ``` ## Dry-Run Generic `PUT`, `POST` and `DELETE` endpoints support to perform operations in a "dry-run-mode". Where possible, business logic is executed and the data submitted by the requester is validated. To use this functionality the requester can set the optional query parameter "`dryRun`" (boolean, default: `false`). The return is as far as possible as with a productive execution, except that 200 "ok" is returned in case of success. The meta properties (id, version, createdDate, lastModifiedDate) are not included in "dry-run-responses". ### `POST /salesOrder?dryRun=true` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ -H Content-Type: application/json \ -X POST "https://<TENANT>.weclapp.com/webapp/api/v2/salesOrder?dryRun=true" \ -d '{ "customerNumber": "4799" }' ``` **Error Output:** ```json { "detail": "customer not found", "error": "customer not found", "status": 400, "title": "entity validation failed", "type": "/webapp/view/api/errors.html#!/errors/validation", "validationErrors": [ { "detail": "referenced entity not found", "instance": "salesOrder", "location": "customerId", "title": "referenced entity not found", "type": "/webapp/view/api/errors.html#!/validation/reference" } ] } ``` The response status will be 400 (Bad Request). **Successful Output:** ```json { "availability": "NOT_CHECKED", "availabilityForAllWarehouses": "NOT_CHECKED", "commissionSalesPartners": [], "creatorId": "4451", "currencyConversionDate": 1699375721469, "currencyConversionRate": "1", "customAttributes": [], "customerId": "4799", "customerNumber": "10000", "deliveryAddress": { "city": "Hithausen", "company": "Beispiel AG", "countryCode": "DE", "street1": "Feldstraße 34", "zipcode": "54321" }, "deliveryEmailAddresses": { "toAddresses": "info@beispielag.de" }, "disableEmailTemplate": false, "dispatchCountryCode": "DE", "factoring": false, "fulfillmentProviderId": "3335", "grossAmount": "0", "grossAmountInCompanyCurrency": "0", "headerDiscount": "0", "headerSurcharge": "0", "invoiceAddress": { "city": "Hithausen", "company": "Beispiel AG", "countryCode": "DE", "street1": "Feldstraße 34", "zipcode": "54321" }, "invoiced": false, "netAmount": "0", "netAmountInCompanyCurrency": "0", "nonStandardTaxId": "3492", "nonStandardTaxName": "DE Steuerfrei Drittland (VK)", "onlyServices": false, "orderDate": 1699311600000, "orderItems": [], "paid": false, "plannedShippingDate": 1699311600000, "pricingDate": 1699311600000, "projectMembers": [], "projectModeActive": false, "recordAddress": { "city": "Hithausen", "company": "Beispiel AG", "countryCode": "DE", "street1": "Feldstraße 34", "zipcode": "54321" }, "recordCurrencyId": "256", "recordCurrencyName": "EUR", "recordEmailAddresses": { "toAddresses": "info@beispielag.de" }, "responsibleUserId": "4748", "responsibleUserUsername": "karsten.kunde@example.com", "salesChannel": "NET1", "salesInvoiceEmailAddresses": { "toAddresses": "info@beispielag.de" }, "salesOrderPaymentType": "STANDARD", "sentToRecipient": false, "servicesFinished": false, "shipped": false, "shippingCostItems": [], "shippingLabelsCount": 1, "status": "ORDER_ENTRY_IN_PROGRESS", "statusHistory": [ { "status": "ORDER_ENTRY_IN_PROGRESS", "statusDate": 1699375721472, "userId": "4451" } ], "tags": [], "warehouseId": "4191", "warehouseName": "Hauptlager" } ``` The response status will be 200 (OK). ## Optimistic locking For the update operation the resources usually also support optimistic locking using the `version` property: if the `version` property is in the request body and it does not match the current `version`, then the request fails with an optimistic lock error. In that case the caller should again get the latest `version`, apply the changes and try the request again. ## Basic Operations The following entries will show you how to use the different basic operations (`GET`, `POST`, `PUT`, `DELETE`) and what an exemplary response they will give whether the operation was successful or not. The following table will show you the HTTP status codes of the basic operations if the operation was successful: | Operation | HTTP status code | |-----------|------------------| | GET | 200 (OK) | | POST | 201 (Created) | | PUT | 200 (OK) | | DELETE | 204 (No Content) | If you are not currently logged in to weclapp, you are using another browser or the AuthenticationToken was wrong you will get a response of `401 (Unauthorized)`. If you have insufficient privileges for the operation you will get a `403 (Forbidden)`. It is possible to disable the optimistic locking check by just omitting the `version` property, but doing this might accidentally overwrite changes done by another user in the meantime. ## Get a specific entity instance Each entity instance has its own URL where it can be retrieved. The URL is based on the entity id. Performing a GET request on that URL returns the entity instance: ### `GET /customer/id/3346` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" "https://<TENANT>.weclapp.com/webapp/api/v2/customer/id/3346" ``` **Output:** ```json { "result": [ { "id": "3346", "version": "2", "addresses": [ { "id": "3348", "version": "0", "countryCode": "DE", "createdDate": 1487765943229, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1487765943229, "primeAddress": true }, { "id": "3976", "version": "0", "company": "11111", "company2": "22222", "countryCode": "DE", "createdDate": 1496040807652, "deliveryAddress": false, "globalLocationNumber": "gln", "invoiceAddress": false, "lastModifiedDate": 1496040807648, "primeAddress": false } ], "blocked": false, "company": "Musterdaten GmbH", "contacts": [ { "id": "3377", "version": "0", "addresses": [ { "id": "3379", "version": "0", "countryCode": "DE", "createdDate": 1487767121646, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1487767121645, "primeAddress": true } ], "createdDate": 1487767121649, "firstName": "Max", "lastModifiedDate": 1487767121642, "lastName": "Mustermann", "partyType": "PERSON", "personCompany": "Musterdaten GmbH", "salutation": "MR" } ], "createdDate": 1487765943230, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048" } ], "customerNumber": "C1002", "customerTopics": [], "deliveryBlock": false, "insolvent": false, "insured": false, "lastModifiedDate": 1496040807672, "optIn": false, "partyType": "ORGANIZATION", "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "@weclapp.com", "salesChannel": "NET1", "useCustomsTariffNumber": false } ] } ``` ## Create a new instance Creating new instances is done by performing a POST request to the base URL of a resource. The body for that request must have the same structure as the result of the "get by id" request, but usually not all properties need to be specified and there are defaults for some properties. Here are some general notes: * id, version, createdDate and lastModifiedDate can usually not be set by the client, so those values are ignored if they are specified * references to other entities are often represented by two properties (usually id and some other more or less unique property of the referenced entity), for example customer has currencyId and currencyName to reference the currency, when creating a new customer then it is not necessary to specify both properties, one of them is usually enough as long as it specifies the referenced entity uniquely, if both are given then they must not contradict each other * usually some required properties have sensible defaults, so if those are not given or null then the default will be used * boolean properties can be optional (default value would be set) or mandatory ### `POST /customer` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ -H Content-Type: application/json \ -X POST "https://<TENANT>.weclapp.com/webapp/api/v2/customer" \ -d '{ "customerNumber": "C1013", "partyType": "ORGANIZATION", "company": "Firma" }' ``` **Output:** ```json { "id": "4391", "version": "0", "addresses": [ { "id": "4393", "version": "0", "countryCode": "DE", "createdDate": 1496840784272, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1496840784272, "primeAddress": true } ], "blocked": false, "company": "Firma", "contacts": [], "createdDate": 1496840784273, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048" } ], "customerNumber": "C1013", "customerTopics": [], "deliveryBlock": false, "insolvent": false, "insured": false, "lastModifiedDate": 1496840784270, "optIn": false, "partyType": "ORGANIZATION", "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "sales@weclapp.com", "salesChannel": "NET1", "useCustomsTariffNumber": false } ``` The response status will be 201 (Created) and the response will have a `Location` header pointing to the URL of the created instance. ## Update a specific instance Updating an instances is done by performing a `PUT` request to the URL of the instance. A successful response will have the status 200 (OK) and the response body will contain the updated entity. Some special aspects must be considered when updating: * the read-only properties like `createdDate` are ignored anyway, so they do not need to be given * `id` and `version` are processed as follows: if the `id` is given it must match the `id` of the updated instance and if the `version` is given then optimistic locking is enabled (see below) * for the references that use two properties it is again possible to specify only one of them, if both are given then they must not contradict each other * for complete entity updates boolean properties are always mandatory and need to be passed ### Updating the complete entity When updating it is generally necessary to specify all properties that are not `null`, all unspecified properties will be interpreted as `null`. Since sometimes new properties are added to entities, it is strongly recommended that an API client always first gets the latest version using `GET/customer/id/{id}`, then modifies that JSON and finally performs the `PUT` request. Doing this ensures that new properties that the client does not know about are not accidentally overwritten with `null`. In this example only the property "company" will be updated. All other properties are unchanged. ### `PUT /customer/id/4391` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ -H Content-Type: application/json \ -X PUT "https://<TENANT>.weclapp.com/webapp/api/v2/customer/id/4391" \ -d @- <<JSON { "id": "4391", "version": "0", "addresses": [ { "id": "4393", "version": "0", "countryCode": "DE", "createdDate": 1496840784272, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1496840784272, "primeAddress": true } ], "blocked": false, "company": "NEUER FIRMENNAME!!!", "contacts": [], "createdDate": 1496840784273, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048" } ], "customerNumber": "C1013", "customerTopics": [], "deliveryBlock": false, "insolvent": false, "insured": false, "lastModifiedDate": 1496840784270, "optIn": false, "partyType": "ORGANIZATION", "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "sales@weclapp.com", "salesChannel": "NET1", "useCustomsTariffNumber": false } JSON ``` **Output:** ```json { "id": "4391", "version": "1", "addresses": [ { "id": "4393", "version": "0", "countryCode": "DE", "createdDate": 1496840784272, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1496840784272, "primeAddress": true } ], "blocked": false, "company": "NEUER FIRMENNAME!!!", "contacts": [], "createdDate": 1496840784273, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048" } ], "customerNumber": "C1013", "customerTopics": [], "deliveryBlock": false, "insolvent": false, "insured": false, "lastModifiedDate": 1496842955268, "optIn": false, "partyType": "ORGANIZATION", "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "sales@weclapp.com", "salesChannel": "NET1", "useCustomsTariffNumber": false } ``` ### Updating only specific properties It is also possible to update only specific properties. For this you only have to set the parameter `ignoreMissingProperties=true`. We recommend to always include `version` here as well to activate optimistic locking. If you want to change lists (add, update or delete an item) stored in the entity, it is sufficient to specify the id for existing item entities. In this example only the property "company" will be updated. All other properties are unchanged. ### `PUT /customer/id/4391` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" \ -H Content-Type: application/json \ -X PUT "https://<TENANT>.weclapp.com/webapp/api/v2/customer/id/4391?ignoreMissingProperties=true" \ -d '{ "version": "0", "company": "NEUER FIRMENNAME!!!" }' ``` **Output:** ```json { "id": "4391", "version": "1", "addresses": [ { "id": "4393", "version": "0", "countryCode": "DE", "createdDate": 1496840784272, "deliveryAddress": false, "invoiceAddress": false, "lastModifiedDate": 1496840784272, "primeAddress": true } ], "blocked": false, "company": "NEUER FIRMENNAME!!!", "contacts": [], "createdDate": 1496840784273, "currencyId": "248", "currencyName": "EUR", "customAttributes": [ { "attributeDefinitionId": "4048" } ], "customerNumber": "C1013", "customerTopics": [], "deliveryBlock": false, "insolvent": false, "insured": false, "lastModifiedDate": 1496842955268, "optIn": false, "partyType": "ORGANIZATION", "responsibleUserFixed": false, "responsibleUserId": "947", "responsibleUserUsername": "sales@weclapp.com", "salesChannel": "NET1", "useCustomsTariffNumber": false } ``` ### Optimistic locking For the update operation the resources usually also support optimistic locking using the version property: if the version property is in the request body and it does not match the current version, then the request fails with an optimistic lock error. In that case the caller should again get the latest version, apply the changes and try the request again. It is possible to disable the optimistic locking check by just omitting the version property, but doing this might accidentally overwrite changes done by another user in the meantime. ## Delete a specific instance Deleting an instances is done by performing a `DELETE` request to the URL of the instance. ### `DELETE /customer/id/{id}` ```bash curl --compressed -H "AuthenticationToken:<TOKEN>" -X DELETE "https://<TENANT>.weclapp.com/webapp/api/v2/customer/id/4391" ``` If the deletion is possible it is performed and the response status will be 204 (No Content), otherwise an error response will be returned. <span id="errors"> </span> # API error reference weclapp API errors are basically conformant to [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807), with some notable differences: * The migration to the RFC 7807 structure is an ongoing process, so some compatibility mechanisms are in place for now: * The responses come with "`Content-Type: application/json`" instead of "`Content-Type: application/problem+json`" * The "unstructured" error responses that have been in use until now are still part of the response JSON, so existing code should work without changes. * Detail information that _should_ be there according to the new structure may be still missing. This applies especially to all kinds of validation errors. * Two custom fields have been added to the response structure: "location" and "validationErrors". See the general description below and the individual error descriptions for details on these. ## Error JSON structure The error JSON is structured as described in [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807), with two additional properties: | Property | Datatype | Description | |------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | type | string | (relative) URI reference that identifies the problem type, pointing to the error description in this document. To technically distinguish individual types of errors it is recommended to only evaluate the part after the last '/'. | | title | string | (RFC7807) A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see RFC7231, Section 3.4). | | status | integer | (RFC7807) The HTTP status code (RFC7231, Section 6) generated by the origin server for this occurrence of the problem. | | detail | string | (RFC7807) A human-readable explanation specific to this occurrence of the problem. This may be missing when the actual detail information either would be security sensitive (e.g. on unexpected errors) or is contained in the validationErrors. | | instance | string | (RFC7807) A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. In weclapp, this typically is the URI to the affected entity. | | validationErrors | array of objects | List of found validation errors, with a structure modeled after RFC 7807 as well (see below). | Validation errors have a similar structure: | Property | Datatype | Description | |-----------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | type | string | (relative) URI reference that identifies the problem type, pointing to the error description in this document. To technically distinguish individual types of errors it is recommended to only evaluate the part after the last '/'. | | title | string | (RFC7807) A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see RFC7231, Section 3.4). | | detail | string | (RFC7807) A human-readable explanation specific to this occurrence of the problem. | | errorCode | string | Unique identifier of the concrete business error | | instance | string | (RFC7807) A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. In weclapp, this is the name of the affected parameter or the URI to the affected entity. | | location | string | The JsonPath location of the affected property. | | allowed | array of strings | List of allowed values, with semantics dependent on the concrete validation error. | ## Error reference <span id="!/errors/context"></span> ### "context": operation not possible in this context | | | |------------|---------------------------------------| | description | The operation is not possible in this context or with the current state of the data | | type | [/webapp/view/api/errors.html#!/errors/context](/webapp/view/api/errors.html#!/errors/context) | | status | 409 (Conflict)| <span id="!/errors/conversation"></span> ### "conversation": existing conversation (parameter 'cid') is not allowed | | | |------------|---------------------------------------| | description | The request was sent in the context of a running session, which is not allowed for the (stateless) API | | type | [/webapp/view/api/errors.html#!/errors/conversation](/webapp/view/api/errors.html#!/errors/conversation) | | status | 400 (Bad Request)| | detail | human readable information on the conversation | <span id="!/errors/entity_not_found"></span> ### "entity_not_found": (sub)entity not found | | | |------------|---------------------------------------| | description | The specified entity or (more likely) a referenced sub-entity could not be found. | | type | [/webapp/view/api/errors.html#!/errors/entity_not_found](/webapp/view/api/errors.html#!/errors/entity_not_found) | | status | 400 (Bad Request)| <span id="!/errors/forbidden"></span> ### "forbidden": insufficient privileges | | | |------------|---------------------------------------| | description | The provided credentials are not sufficient to perform the requested operation | | type | [/webapp/view/api/errors.html#!/errors/forbidden](/webapp/view/api/errors.html#!/errors/forbidden) | | status | 403 (Forbidden)| <span id="!/errors/invalid_json"></span> ### "invalid_json": invalid json | | | |------------|---------------------------------------| | description | The JSON passed in the request body could not be parsed or the body is not JSON at all. | | type | [/webapp/view/api/errors.html#!/errors/invalid_json](/webapp/view/api/errors.html#!/errors/invalid_json) | | status | 400 (Bad Request)| <span id="!/errors/not_found"></span> ### "not_found": resource not found | | | |------------|---------------------------------------| | description | The API endpoint / method / entity could not be found | | type | [/webapp/view/api/errors.html#!/errors/not_found](/webapp/view/api/errors.html#!/errors/not_found) | | status | 404 (Not Found)| <span id="!/errors/optimistic_lock"></span> ### "optimistic_lock": optimistic lock error | | | |------------|---------------------------------------| | description | Optimistic Lock error. This appears if an entity you tried to modify has been modified by someone else in the meantime. See 'Optimistic Locking' in the 'API operations sample' section of the docs. | | type | [/webapp/view/api/errors.html#!/errors/optimistic_lock](/webapp/view/api/errors.html#!/errors/optimistic_lock) | | status | 409 (Conflict)| | instance | URI to affected entity if available | <span id="!/errors/persistence"></span> ### "persistence": persistence error | | | |------------|---------------------------------------| | description | Catchall for persistence related problems that are not covered by more specific errors. In some cases it is sufficient to try again after a short time, but if the problem persists please contact support. | | type | [/webapp/view/api/errors.html#!/errors/persistence](/webapp/view/api/errors.html#!/errors/persistence) | | status | 409 (Conflict)| <span id="!/errors/unauthorized"></span> ### "unauthorized": missing permission | | | |------------|---------------------------------------| | description | Authorization or authentication problem | | type | [/webapp/view/api/errors.html#!/errors/unauthorized](/webapp/view/api/errors.html#!/errors/unauthorized) | | status | 401 (Unauthorized)| <span id="!/errors/unexpected"></span> ### "unexpected": unexpected error | | | |------------|---------------------------------------| | description | Catchall error for everything that is not covered by more specific errors. This is typically caused by a bug in weclapp. | | type | [/webapp/view/api/errors.html#!/errors/unexpected](/webapp/view/api/errors.html#!/errors/unexpected) | | status | 500 (Internal Server Error)| <span id="!/errors/unsupported_mime_type"></span> ### "unsupported_mime_type": unsupported mime type | | | |------------|---------------------------------------| | description | The provided file type is not supported to perform the requested operation | | type | [/webapp/view/api/errors.html#!/errors/unsupported_mime_type](/webapp/view/api/errors.html#!/errors/unsupported_mime_type) | | status | 415 (Unsupported Media Type)| <span id="!/errors/validation"></span> ### "validation": validation failed | | | |------------|---------------------------------------| | description | The input (entity properties / URL parameters) is malformed or not allowed in this context | | type | [/webapp/view/api/errors.html#!/errors/validation](/webapp/view/api/errors.html#!/errors/validation) | | status | 400 (Bad Request)| | validationErrors | validation errors | ## Validation error reference <span id="!/validation/authorization"></span> ### "authorization": no authorization to access property or referenced entity | | | |------------|---------------------------------------| | description | The client lacks authorization to access the property or referenced entity | | type | [/webapp/view/api/errors.html#!/validation/authorization](/webapp/view/api/errors.html#!/validation/authorization) | <span id="!/validation/blocked"></span> ### "blocked": operation was blocked | | | |------------|---------------------------------------| | description | The operation was blocked by referenced entities | | type | [/webapp/view/api/errors.html#!/validation/blocked](/webapp/view/api/errors.html#!/validation/blocked) | <span id="!/validation/consistency"></span> ### "consistency": values are inconsistent | | | |------------|---------------------------------------| | description | The given values are inconsistent (general, unspecific error) | | type | [/webapp/view/api/errors.html#!/validation/consistency](/webapp/view/api/errors.html#!/validation/consistency) | <span id="!/validation/digits"></span> ### "digits": maximum number of digits exceeded | | | |------------|---------------------------------------| | description | The numerical value given has more than the allowed maximum number of integer and/or fractional digits | | type | [/webapp/view/api/errors.html#!/validation/digits](/webapp/view/api/errors.html#!/validation/digits) | | allowed | maximum allowed integer digits, maximum allowed fraction digits | <span id="!/validation/duplicate"></span> ### "duplicate": entity is a duplicate | | | |------------|---------------------------------------| | description | The given (sub-)entity is a duplicate | | type | [/webapp/view/api/errors.html#!/validation/duplicate](/webapp/view/api/errors.html#!/validation/duplicate) | <span id="!/validation/email"></span> ### "email": not a well-formed email | | | |------------|---------------------------------------| | description | The value given is not a well-formed email address | | type | [/webapp/view/api/errors.html#!/validation/email](/webapp/view/api/errors.html#!/validation/email) | <span id="!/validation/email_or_domain"></span> ### "email_or_domain": not a well-formed email or domain | | | |------------|---------------------------------------| | description | The value given is not a well-formed email address or internet domain name | | type | [/webapp/view/api/errors.html#!/validation/email_or_domain](/webapp/view/api/errors.html#!/validation/email_or_domain) | <span id="!/validation/empty"></span> ### "empty": value must be empty | | | |------------|---------------------------------------| | description | The value given must be left blank in this context, but is present | | type | [/webapp/view/api/errors.html#!/validation/empty](/webapp/view/api/errors.html#!/validation/empty) | <span id="!/validation/enum"></span> ### "enum": unsupported enum value | | | |------------|---------------------------------------| | description | The given enum value is unknown or unsupported in this context | | type | [/webapp/view/api/errors.html#!/validation/enum](/webapp/view/api/errors.html#!/validation/enum) | | allowed | all known / allowed (enum) values | <span id="!/validation/future"></span> ### "future": timestamp has to be in the future | | | |------------|---------------------------------------| | description | The given timestamp should be in the future but is not | | type | [/webapp/view/api/errors.html#!/validation/future](/webapp/view/api/errors.html#!/validation/future) | <span id="!/validation/greater_than"></span> ### "greater_than": value has to be above allowed limit | | | |------------|---------------------------------------| | description | The numerical value given has to be larger than the allowed limit | | type | [/webapp/view/api/errors.html#!/validation/greater_than](/webapp/view/api/errors.html#!/validation/greater_than) | | allowed | lower limit (excluded) | <span id="!/validation/less_than"></span> ### "less_than": value has to be below allowed limit | | | |------------|---------------------------------------| | description | The numerical value given has to be smaller than the allowed limit | | type | [/webapp/view/api/errors.html#!/validation/less_than](/webapp/view/api/errors.html#!/validation/less_than) | | allowed | upper limit (excluded) | <span id="!/validation/max"></span> ### "max": value is above allowed maximum | | | |------------|---------------------------------------| | description | The numerical value given is larger than the allowed maximum | | type | [/webapp/view/api/errors.html#!/validation/max](/webapp/view/api/errors.html#!/validation/max) | | allowed | maximum allowed value | <span id="!/validation/min"></span> ### "min": value is below allowed minimum | | | |------------|---------------------------------------| | description | The numerical value given is smaller than the allowed minimum | | type | [/webapp/view/api/errors.html#!/validation/min](/webapp/view/api/errors.html#!/validation/min) | | allowed | minimum allowed value | <span id="!/validation/not_empty"></span> ### "not_empty": value must not be empty | | | |------------|---------------------------------------| | description | The value given is required, but is missing or blank | | type | [/webapp/view/api/errors.html#!/validation/not_empty](/webapp/view/api/errors.html#!/validation/not_empty) | <span id="!/validation/past"></span> ### "past": timestamp has to be in the past | | | |------------|---------------------------------------| | description | The given timestamp should be in the past but is not | | type | [/webapp/view/api/errors.html#!/validation/past](/webapp/view/api/errors.html#!/validation/past) | <span id="!/validation/pattern"></span> ### "pattern": value has to conform to a specific pattern | | | |------------|---------------------------------------| | description | The text given does not conform to the allowed pattern | | type | [/webapp/view/api/errors.html#!/validation/pattern](/webapp/view/api/errors.html#!/validation/pattern) | | allowed | the pattern (regular expression) | <span id="!/validation/reference"></span> ### "reference": referenced entity not found | | | |------------|---------------------------------------| | description | The referenced entity could not be found | | type | [/webapp/view/api/errors.html#!/validation/reference](/webapp/view/api/errors.html#!/validation/reference) | <span id="!/validation/size"></span> ### "size": size is outside allowed range | | | |------------|---------------------------------------| | description | The text or collection given has not enough or too many characters or elements | | type | [/webapp/view/api/errors.html#!/validation/size](/webapp/view/api/errors.html#!/validation/size) | | allowed | minimum size, maximum size | <span id="!/validation/syntax"></span> ### "syntax": expression cannot be interpreted | | | |------------|---------------------------------------| | description | The given expression does not conform to the expression syntax | | type | [/webapp/view/api/errors.html#!/validation/syntax](/webapp/view/api/errors.html#!/validation/syntax) | <span id="!/validation/type"></span> ### "type": unexpected data type | | | |------------|---------------------------------------| | description | The given value is of a data type that's not supported in this context | | type | [/webapp/view/api/errors.html#!/validation/type](/webapp/view/api/errors.html#!/validation/type) |

  3 0

• PHP

  kruegge82/dhl-php-sdk

  DHL SDK REST API for developer.dhl.com

  Abandoned! See kruegge82/dhl-php-rest-sdk

  964 4