How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AEB Carrier Definition API

Rest API for carrier definitions

AEB Carrier Definition API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CarrierDefinition. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 8 operations across 8 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://rz3.aeb.de/demo1cai/rest.

8 operations 8 paths 19 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://rz3.aeb.de/test2ici/rest
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

AEB Carrier Definition API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY). It accepts HTTP basic authentication (BASIC_AUTH). By default, every request must be authenticated.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

CarrierDefinition 8

Rest API for carrier definitions

GET
/carrier-definitions/{id}
Returns a carrier definition with the requested ID. If the ID does not exist, an error will be returned
getCarrierDefinition 1 param → 200404
GET
/carrier-definitions
Returns all carrier definitions matching the given filter criteria. In case no carrier definition matches the given filter criteria an empty carrier definition collection is returned. All filter fiel…
searchCarrierDefinitions 5 params → 200
GET
/carrier-definitions/{id}/additional-values
Returns a list of all the additional values of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
getAdditionalValueDefinitions 1 param → 200404
GET
/carrier-definitions/{id}/carrier-info-texts
Returns a list of all the carrier info texts of a carrier definition with the requested ID.
getCarrierInfoTextDefinitions 2 params → 200404
GET
/carrier-definitions/{id}/despatch-countries
Returns a list of all the despatch countries of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
getCarrierDespatchCountries 1 param → 200404
GET
/carrier-definitions/{id}/logos
Returns the logos of a carrier with the requested ID. If the ID does not exist, an error will be returned
getCarrierDefinitionLogos 1 param → 200404
GET
/carrier-definitions/{id}/services
Returns a list of all the services of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
getServiceDefinitions 2 params → 200404
GET
/carrier-definitions/{id}/value-added-services
Returns a list of all the value added services of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
getValueAddedServiceDefinitions 2 params → 200404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ServiceDefinition (9 properties), CarrierInfoTextDefinition (6 properties), CarrierDefinition (5 properties), AdditionalValueDefinition (4 properties). Each schema is shown below with its type and property counts.

ServiceDefinitionPage
object
2 properties 2 required
CarrierDefinitionPage
object
2 properties 2 required
CarrierInfoTextDefinitionPage
object
2 properties 2 required
AdditionalValueDefinitionTextTranslation
object
Name of the additional value in a certain language.
2 properties 1 required
ValueAddedServiceDefinitionPage
object
2 properties 2 required
AdditionalValueDefinitionDefinitionPage
object
2 properties 2 required
CarrierExtendedInfo
object
Extended information of the carrier.
2 properties
ServiceDefinitionTextTranslation
object
Name and description of the service in a certain language.
3 properties 1 required
ValueAddedServiceDefinitionTextTranslation
object
Name and description of the value added service in a certain language.
3 properties 1 required
CarrierInfoTextDefinition
object
Information about the additional info text the carrier offers.
6 properties 4 required
CarrierDefinitionTextTranslation
object
Name of the carrier in a certain language.
2 properties 1 required
CarrierDefinition
object
The most important information of the carrier definition.
5 properties 4 required
ServiceDefinition
object
Information about the service the carrier offers.
9 properties 1 required
CarrierDespatchCountryPage
object
2 properties 2 required
AdditionalValueDefinition
object
Information about the additional value the carrier offers.
4 properties 4 required
CarrierInfoTextDefinitionTextTranslation
object
Description of the carrier info text in a certain language.
2 properties 1 required
CarrierDespatchCountry
object
Information about the supported despatch country of the carrier.
2 properties
ValueAddedServiceDefinition
object
Information about the value added service the carrier offers.
3 properties 3 required
CarrierDefinitionLogos
object
The logos of the carrier.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-carrierdefinition-api-openapi.yml Raw ↑

Other APIs AEB publishes across the network.

AEB AEB Delivery API
AEB Billing API
AEB Billing Scenario API
AEB BIS Audit BF Bean API
AEB BISBF Bean API
AEB BSM Carrier API
AEB BSM International Customs API
AEB BSM Sync API
AEB Carrier API
AEB Carrier Description API
AEB Carrier Event Service BF Bean API
AEB Carrier Setup API
Where this information came from

This is an independent, third-party profile of AEB Carrier Definition API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.