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 Setup API

Rest API for carrier setups

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

Tagged areas include CarrierSetup. 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 26 operations across 12 paths, and defines 17 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.

26 operations 12 paths 17 schemas 5 DELETE12 GET9 PUT

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 Setup 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 26

Across 12 paths, the API surfaces 26 operations — 5 DELETE, 12 GET, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

CarrierSetup 26

Rest API for carrier setups

GET
/carrier-setups/{id}
Returns a carrier setup with the requested ID.
getCarrierSetup 1 param → 200404
PUT
/carrier-setups/{id}
Create or update a carrier setup with the requested ID. If the carrier setup with the given ID does not exist, a new carrier setup will be created. If the carrier setup exists, the existing carrier s…
createOrUpdateCarrierSetup 1 param body → 200409404
DELETE
/carrier-setups/{id}
Delete a carrier setup with the requested ID.
deleteCarrierSetup 1 param → 200409404
GET
/carrier-setups
Returns all carrier setups matching the given filter criteria. In case no carrier setup matches the given filter criteria an empty collection is returned. If the filter field supports place holders (…
searchCarrierSetups 3 params → 200
GET
/carrier-setups/{id}/additional-values/{additional-value-id}
Returns an additional value setup of a carrier setup with the requested ID.
getAdditionalValueSetup 2 params → 200404
PUT
/carrier-setups/{id}/additional-values/{additional-value-id}
Create or update an additional value setup of a carrier setup with the requested ID. If the additional value setup with the given ID does not exist, a new additional value setup will be created. If t…
createOrUpdateAdditionalValueSetup 2 params body → 200400404500
DELETE
/carrier-setups/{id}/additional-values/{additional-value-id}
Deletes an additional value setup of a carrier setup with the requested ID.
deleteAdditionalValueSetup 2 params → 200404
GET
/carrier-setups/{id}/additional-values
Returns all additional value setups of a carrier setup.
getAdditionalValueSetups 1 param → 200404
PUT
/carrier-setups/{id}/additional-values
Create or update all additional value setups of a carrier setup with the requested ID. If the additional value setup with the given ID does not exist, a new additional value setup will be created. If…
createOrUpdateAllAdditionalValueSetups 1 param body → 200400404500
GET
/carrier-setups/{id}/application-url
Returns the application URL of a carrier setup with the requested ID.
getCarrierSetupApplicationURL 1 param → 200404
GET
/carrier-setups/{id}/carrier-info-texts
Returns all carrier info text setups of a carrier setup.
getCarrierInfoTextSetups 1 param → 200404
PUT
/carrier-setups/{id}/carrier-info-texts
Create or update all carrier info text setups of a carrier setup with the requested ID. If the carrier info text setup with the given ID does not exist, a new carrier info text setup will be created.…
createOrUpdateAllCarrierInfoTextSetups 1 param body → 200409404
GET
/carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}
Returns a carrier info text setup of a carrier setup with the requested ID.
getCarrierInfoTextSetup 2 params → 200404
PUT
/carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}
Create or update a carrier info text setup of a carrier setup with the requested ID. If the carrier info text setup with the given ID does not exist, a new carrier info text setup will be created. If…
createOrUpdateCarrierInfoTextSetup 2 params body → 200409404
DELETE
/carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}
Deletes a carrier info text setup of a carrier setup with the requested ID.
deleteCarrierInfoTextSetup 2 params → 200409404
GET
/carrier-setups/{id}/services
Returns all service setups of a carrier setup.
getServiceSetups 1 param → 200404
PUT
/carrier-setups/{id}/services
Create or update all service setups of a carrier setup with the requested ID. If the service setup with the given ID does not exist, a new service setup will be created. If the service setup exist, t…
createOrUpdateAllServiceSetups 1 param body → 200409404
GET
/carrier-setups/{id}/services/{service-id}
Returns a service setup of a carrier setup with the requested ID.
getServiceSetup 2 params → 200404
PUT
/carrier-setups/{id}/services/{service-id}
Create or update a service setup of a carrier setup with the requested ID. If the service setup with the given ID does not exist, a new service setup will be created. If the service setup exist, the…
createOrUpdateServiceSetup 2 params body → 200409404
DELETE
/carrier-setups/{id}/services/{service-id}
Deletes a service setup of a carrier setup with the requested ID.
deleteServiceSetup 2 params → 200409404
GET
/carrier-setups/{id}/status
Returns the status of a carrier setup with the requested ID.
getCarrierSetupStatus 1 param → 200404
GET
/carrier-setups/{id}/value-added-services
Returns all value added service setups of a carrier setup.
getValueAddedServiceSetups 1 param → 200404
PUT
/carrier-setups/{id}/value-added-services
Create or update all value added service setups of a carrier setup with the requested ID. If the value added service setup with the given ID does not exist, a new value added service setup will be cr…
createOrUpdateAllValueAddedServiceSetups 1 param body → 200404
GET
/carrier-setups/{id}/value-added-services/{value-added-service-id}
Returns a value added service setup of a carrier setup with the requested ID.
getValueAddedServiceSetup 2 params → 200404
PUT
/carrier-setups/{id}/value-added-services/{value-added-service-id}
Create or update a value added service setup of a carrier setup with the requested ID. If the value added service setup with the given ID does not exist, a new value added service setup will be creat…
createOrUpdateValueAddedServiceSetup 2 params body → 200404
DELETE
/carrier-setups/{id}/value-added-services/{value-added-service-id}
Deletes a value added service setup of a carrier setup with the requested ID.
deleteValueAddedServiceSetup 2 params → 200404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AebProblem (8 properties), AebProblemError (4 properties), CarrierSetup (4 properties), AdditionalValueSetupAttributes (4 properties). Each schema is shown below with its type and property counts.

CarrierInfoTextSetupPage
object
1 property 1 required
AdditionalValueSetupAttributes
object
Information about the additional value setup.
4 properties 4 required
ServiceSetup
object
List of service setups.
3 properties 1 required
AebProblemError
object
Array of related errors
4 properties
ChoiceEntryTextTranslation
object
Name of the choice entry in a certain language.
2 properties 1 required
AdditionalValueSetupPage
object
1 property 1 required
CarrierSetupStatus
object
The status of a carrier setup.
1 property 1 required
AdditionalValueChoiceEntry
object
Additional information about the choice entry of an additional value.
3 properties 2 required
ValueAddedServicePage
object
1 property 1 required
CarrierSetupPage
object
2 properties 2 required
ServiceSetupPage
object
1 property 1 required
AdditionalValuesSetup
object
Information about an additional value setup.
3 properties 2 required
AebProblem
object
8 properties
CarrierSetup
object
The most important information of the carrier setup.
4 properties 3 required
ValueAddedService
object
Information about the value added service setup.
3 properties 1 required
CarrierInfoTextSetup
object
List of carrier info text setups.
3 properties 1 required
AdditionalValueTextTranslation
object
Name of the additional value in a certain language.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-carriersetup-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 Definition API
AEB Carrier Description API
AEB Carrier Event Service BF Bean API
Where this information came from

This is an independent, third-party profile of AEB Carrier Setup 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.