AEB International Customs BF Bean API
Interface overview for Customs Management
AEB International Customs BF Bean API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include InternationalCustomsBFBean. 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 17 operations across 16 paths, and defines 151 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://rz3.aeb.de/test2ici/rest.
17 operations
16 paths
151 schemas
1 GET16 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB International Customs BF Bean 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 17
Across 16 paths, the API surfaces 17 operations — 1 GET, 16 POST. Each is listed below with its method, path, parameters, and response codes.
InternationalCustomsBFBean 17
Interface overview for Customs Management
POST
/InternationalCustomsBFBean/acknowledgeGetChangedDeclarations
Acknowledge call of get changed declarations
POST
/InternationalCustomsBFBean/addDeclarationAttachmentsdeprecated
Add declaration attachments
POST
/InternationalCustomsBFBean/cancelConsignment
Cancel consignment
POST
/InternationalCustomsBFBean/cancelConsignmentManifest
Cancel consignment manifest
POST
/InternationalCustomsBFBean/cancelDeclaration
Cancel declaration
POST
/InternationalCustomsBFBean/createConsignment
Create a consignment
POST
/InternationalCustomsBFBean/createConsignmentManifest
Create a consignment manifest
POST
/InternationalCustomsBFBean/createDelivery
Create a delivery
POST
/InternationalCustomsBFBean/getBrokerDeclarations
Get broker declarations
POST
/InternationalCustomsBFBean/getChangedDeclarations
Get changed declarations
GET
/InternationalCustomsBFBean/getCodes
Get codes 1
POST
/InternationalCustomsBFBean/getCodes
Get codes
POST
/InternationalCustomsBFBean/getConsignmentsOfManifest
Get consignments of manifest
POST
/InternationalCustomsBFBean/getDeclarationAttachments
Get declaration attachments
POST
/InternationalCustomsBFBean/getDeclarations
Get declarations
POST
/InternationalCustomsBFBean/sendDeclarations
Send declarations
POST
/InternationalCustomsBFBean/setDeclarationAttachmentsStatus
Set declaration attachment status
Schemas 151
The contract defines 151 schemas that model the data the API accepts and returns. The most detailed are ICDeclarationDTO (44 properties), ICDeliveryExtensionDataDTO (33 properties), ICDeliveryItemDTO (33 properties), ICDeliveryItemExtensionDataDTO (32 properties). Each schema is shown below with its type and property counts.
ICConsignmentResultDTO
object
The result DTO which contains the information to the consignment created on the system.
5 properties
OutwardProcessingCommodityCodeFieldDTO
object
Represents a commodity code field for outward processing
2 properties
ICConsignmentDTO
object
DTO to hold data of a consignment.
12 properties
2 required
ICConsignmentInfoDTO
object
Information about an existing consignment.
2 properties
ICDeferredPaymentDTO
object
DTO to hold data for deferred payments.
3 properties
ICCustomsControlMeasureDTO
object
DTO to hold information about control measures.
4 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
ICProducedDocumentEUDTO
object
DTO to hold data for EU produced documents.
15 properties
ICHouseConsignmentDTO
object
Extension data for a house consignment.
4 properties
ICSealDTO
object
DTO to hold data for a seal.
1 property
ICDeliveryTransitEUDTO
object
Holds delivery data that is specific to the EU NCTS / transit processes.
3 properties
ICDeliveryReferencesDTO
object
DTO to hold data of a delivery that has been transitioned into the declaration.
2 properties
ICDeliveryItemExportDEDTO
object
DTO to hold Export DE specific extension data for a ICDeliveryItemDTO.
8 properties
ICMaterialDTO
object
DTO to hold data of a material.
1 property
1 required
ICConsignmentManifestResultDTO
object
Data of the manifest created.
4 properties
ICDeliveryResultDTO
object
The result DTO which contains the information to the delivery created on the system.
4 properties
ICExtraFieldDTO
object
Represents an extra field (or additional field). Extra fields must be configured in ICI and linked to the customs process.
2 properties
ICGetDeclarationsResponseDTO
object
Response containing requested declarations.
5 properties
ICAdditionalDeliveryDataDTO
object
DTO to hold data of a delivery that augment the original delivery data.
9 properties
ICCreateDeliveryRequestDTO
object
The DTO for the request.
5 properties
1 required
ICQuantityDTO
object
DTO to hold data for quantity.
2 properties
ICGetBrokerDeclarationsRequestDTO
object
Request for broker declaration data.
8 properties
ICTradeTermsDTO
object
DTO to hold data of trade terms.
5 properties
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
ICCustomsSpecialProceduresReferencesDTO
object
DTO to hold references to a booking request.
1 property
1 required
ICCustomsWarehouseTerminationDEDTO
object
Customs warehouse termination
2 properties
ICDeliveryConsumerShipmentXIDTO
object
GB specific extension data for Consumer shipments items XI.
3 properties
ICCustomsWarehouseItemReferenceDEDTO
object
DTO to hold specific item reference data for a customs warehouse termination.
8 properties
ICSendDeclarationMessageRequestDTO
object
Body data containing references to declarations that shall be sent to customs.
8 properties
1 required
ICDeclarationGBDTO
object
GB specific extension data for a declaration.
11 properties
ICManifestDeliveryExtensionSTI
object
DTO to hold extension data for import control processes 2 (STI).
3 properties
ICDeliveryItemExtensionDataDTO
object
DTO to hold delivery item extension data for customs processes. Extension data is only required in very rare cases. Not all customs processes are supported.
32 properties
ICDeliveryItemBrokerDTO
object
DTO to hold Broker specific extension data for a ICDeliveryItemDTO}.
2 properties
ICCreateConsignmentManifestRequestDTO
object
Body data for creating a consignment manifest.
5 properties
1 required
ICPackageDTO
object
DTO to hold data of a package.
10 properties
ICDeliveryDTO
object
DTO to hold data of a delivery.
27 properties
2 required
ICCancelConsignmentRequestDTO
object
Body data for the cancellation of a consignment or consignment manifest.
9 properties
ICDeliverySummaryDeclarationDEDTO
object
DTO to hold Summary Declaration DE specific extension data for a ICDeliveryDTO.
4 properties
ICManifestDeliveryExtensionICS
object
DTO to hold extension data for import control processes.
1 property
ICDeliveryItemSTIDTO
object
DTO to hold STI specific extension data for a ICDeliveryItemDTO.
6 properties
ICDeclarationItemExtensionDataDTO
object
DTO to hold declaration item extension data for customs processes. Not all customs processes are supported.
6 properties
ICGetConsignmentsOfManifestRequestDTO
object
Body for requesting consignments of a manifest
6 properties
ICBusinessObjectStatusDTO
object
DTO to hold data of a status.
4 properties
ICGetChangedDeclarationsResponseDTO
object
Response (result) for IInternationalCustomsBFgetChangedDeclarations.
7 properties
ICInvoiceDTO
object
DTO to hold data of an invoice.
5 properties
ICAmountOfMoneyDTO
object
DTO to hold data representing an amount.
2 properties
ICProducedDocumentBrokerDTO
object
DTO to hold data for produced documents.
11 properties
ICCustomsProcedureDTO
object
DTO to hold data for customs procedure codes
2 properties
ICCodeDTO
object
The DTO object containing information of a code and its descriptions in given languages.
2 properties
ICDeliveryItemConsumerShipmentXIDTO
object
GB specific extension data for Consumer shipments XI.
1 property
ICDeclarationPackageDTO
object
DTO to hold data of a package for a declaration item.
4 properties
ICClassificationDTO
object
DTO to hold data for classification.
3 properties
ICDeliveryItemIntrastatDEDTO
object
DTO to hold Intrastat DE specific extension data for a ICDeliveryItemDTO.
5 properties
ICConsignmentForManifestDTO
object
Data to reference an existing consignment.
1 property
1 required
ICGetConsignmentsOfManifestResponseDTO
object
Response containing consignments of a manifest
5 properties
ICDeliverySumDecWriteOffInfoDEDTO
object
DTO to hold the write off data for summary declaration assignment.
2 properties
ICPackedItemDTO
object
DTO to hold data of a packed item.
2 properties
ICDeliveryItemEUDTO
object
DTO to hold EU specific extension data for a ICDeliveryItemDTO.
5 properties
ICDeliveryItemDTO
object
DTO to hold data of a delivery item.
33 properties
ICFreeTemplateCriterionDTO
object
DTO to hold data of a party.
2 properties
ICCancelDeclarationRequestDTO
object
The request dto for the cancellation of declarations BF.
9 properties
2 required
DateAndZoneDTO
object
Date and timezone.
2 properties
ICDeclarationDTO
object
DTO to hold data of a declaration.
44 properties
ICLinkedProcessInfoDTO
object
DTO to hold data of a customs process that is linked to the main declaration object.
3 properties
ICBrokerInstructionDTO
object
DTO to hold data for customs broker instruction
11 properties
ICTransportEquipmentDTO
object
DTO to hold data of transport equipment.
3 properties
ICDeliveryExportUSDTO
object
DTO to hold Export US specific extension data for a ICDeliveryDTO.
10 properties
ClientSpecificFieldDTO
object
Represents a client specific declaration field. Client specific fields must be configured for the resulting declaration and are never intended to be used as ac…
3 properties
ICSetDeclarationAttachmentsStatusRequestDTO
object
The request DTO to set the status of an attachment.
9 properties
ICPartyDTO
object
DTO to hold data of a party.
15 properties
ICPersonDTO
object
DTO to hold data of a person.
7 properties
ICDeliveryImportDEDTO
object
DTO to hold Import DE specific extension data for a ICDeliveryDTO.
12 properties
ICGetBrokerDeclarationsResponseDTO
object
Response containing requested declarations.
5 properties
ICDeclarationCHDTO
object
CH specific extension data for a declaration.
6 properties
ICCreateConsignmentManifestResponseDTO
object
The response DTO after processing the request. Contains the resulting consignment DTO.
5 properties
ICDeclarationItemSpecialProceduresDTO
object
DTO to hold a declaration item's data for customs special procedures.
1 property
ICSendDeclarationMessageResponseDTO
object
Result data for the send-declaration-message operation.
4 properties
ICCreateConsignmentRequestDTO
object
The DTO for the request.
5 properties
1 required
ICReturnsHandlingDTO
object
DTO to hold data related to a returns process.
3 properties
ICDeclarationItemDTO
object
DTO to hold data of a declaration item.
14 properties
ICGetDeclarationAttachmentsResponseDTO
object
Response containing requested attachments.
5 properties
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
OutwardProcessingIdentificationMeansFieldDTO
object
Represents an identification means field for outward processing
2 properties
ICDeliveryItemTransitEUDTO
object
Holds item data that is specific to the EU NCTS / transit processes.
2 properties
ICCustomsOfficeDTO
object
DTO to hold data for a customs office.
3 properties
ICDeclarationItemTransitArrivalDTO
object
Transit arrival specific extension data for a declaration item.
1 property
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
OutwardProcessingFieldDTO
object
Represents an outward processing field
5 properties
ICWarehouseDTO
object
DTO to hold data of customs warehouse.
3 properties
ICAdditionalReferenceDTO
object
DTO to hold data of a additional reference.
5 properties
ICCustomsIdentifcationDTO
object
DTO to hold data for customs identification.
2 properties
ICTransitDeclarationDTO
object
Extension data for a transit.
1 property
ICAttachmentLinkDTO
object
DTO to hold link data.
2 properties
ICDeliveryGVMSGBDTO
object
GB specific extension data for a goods movement record.
3 properties
ICAddDeclarationAttachmentsResponseDTO
object
Result data for the add-declaration-attachments operation.
4 properties
ICAcknowledgeGetChangedDeclarationsRequestDTO
object
Request parameter for IInternationalCustomsBFacknowledgeGetChangedDeclarations
6 properties
ICCancelConsignmentResponseDTO
object
The response dto of the cancellation of consignments or consignment manifests.
5 properties
ICCostDTO
object
DTO to hold data for costs.
4 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
ICReferencedItemDTO
object
Referenced item data for a house consignment.
2 properties
ICCurrencyRateDTO
object
DTO to hold data of currency rate.
2 properties
ICAdditionalFiscalReferenceDTO
object
Data for additional fiscal references
2 properties
QuantityDTO
object
A quantity with a value and a quantity unit. Quantity units are encoded by using AEB unit codes mainly based on the International System of Unit (e.g. 'Gram' i…
3 properties
ICDeliveryExportDEDTO
object
DTO to hold Export DE specific extension data for a ICDeliveryDTO.
12 properties
ICLicenseDataDTO
object
DTO to hold a list of an licenses.
1 property
ICDateDTO
object
DTO to hold data representing an date with optional time.
2 properties
ICDeliveryExportCHDTO
object
DTO to hold CH extension data for a ICDeliveryDTO.
4 properties
ICGetChangedDeclarationsRequestDTO
object
Request parameter for IInternationalCustomsBFgetChangedDeclarations
6 properties
ICManifestDeliveryExtensionDataDTO
object
DTO to hold additional delivery extension data for customs processes. Extension data is only required in very rare cases. Not all customs processes are support…
7 properties
ClientSpecificFieldsDTO
object
Represents the container for client specific fields.
1 property
ICTransportMeansDTO
object
DTO to hold data for transport means.
6 properties
ICDeliveryImportCHDTO
object
DTO to hold CH import extension data for a ICDeliveryDTO.
ICPreviousDocumentDTO
object
DTO to hold data for previous documents.
9 properties
ICDeliveryItemExportUSDTO
object
DTO to hold US specific extension data for a ICDeliveryItemDTO.
6 properties
ICCreateConsignmentResponseDTO
object
The response DTO after processing the request. Contains the resulting consignment DTO.
5 properties
ICSetDeclarationAttachmentsStatusResponseDTO
object
The response DTO after setting an attachment status.
4 properties
ICGuaranteeDTO
object
DTO to hold data of a guarantee.
5 properties
ICAdditionDeductionDTO
object
DTO to hold data for additions and deductions to a base value.
3 properties
ICBrokerDeclarationDTO
object
DTO to hold data for customs broker declaration
11 properties
ICDeclarationExtensionDataDTO
object
DTO to hold declaration extension data for customs processes. Not all customs processes are supported.
11 properties
ICAdditionalOperationCHDTO
object
DTO to hold data for EU produced documents.
6 properties
ICDeclarationItemCHDTO
object
CH specific extension data for a declaration item.
9 properties
ICAcknowledgeGetChangedDeclarationsResponseDTO
object
Response for IInternationalCustomsBFacknowledgeGetChangedDeclarations
4 properties
ICCustomsBrokerDeclarationDTO
object
DTO to hold data for customs broker declaration
1 property
ICAttachmentDTO
object
DTO to hold attachment data.
7 properties
ICCustomsSpecialProceduresDTO
object
DTO to hold data for customs special procedures.
2 properties
ICDeclarationBrokerDTO
object
Broker specific extension data for a declaration.
3 properties
ICDeliveryGMRCHDTO
object
CH specific extension data for a goods movement record.
10 properties
ICDeliveryItemExportCHDTO
object
DTO to hold CH specific extension data for a ICDeliveryItemDTO.
2 properties
ICDeliveryItemImportCHDTO
object
DTO to hold CH specific extension data for a ICDeliveryItemDTO.
ICDeliveryItemImportDEDTO
object
DTO to hold Import DE specific extension data for a ICDeliveryItemDTO.
12 properties
ICAddDeclarationAttachmentsRequestDTO
object
Body data for adding one or more attachments to a declaration.
8 properties
ICGetDeclarationAttachmentsRequestDTO
object
Request for declaration attachments.
7 properties
ICCustomsProcessTypeDTO
object
DTO to hold the customs process type.
2 properties
ICCancelDeclarationResponseDTO
object
The response dto for cancellation of declarations.
5 properties
ICGetCodesRequestDTO
object
Request for a desired code list.
7 properties
2 required
ICLocationDTO
object
DTO to hold data of a location.
16 properties
ICGetDeclarationsRequestDTO
object
Request for declaration data.
9 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
ICLicenseDTO
object
DTO to hold data of an license for a transaction.
10 properties
ICDeliverySTIDTO
object
DTO to hold STI specific extension data for a ICDeliveryDTO.
9 properties
ICGetCodesResponseDTO
object
Response for the requested code list.
5 properties
ICDeliveryEUDTO
object
DTO to hold EU extension data for a ICDeliveryDTO.
7 properties
ICDeliveryBrokerDTO
object
DTO to hold Broker extension data for a ICDeliveryDTO.
1 property
ICConsignmentManifestDTO
object
Structure of a consignment manifest. Additional data for - and references to existing consignments.
10 properties
2 required
ICManifestDeliveryExtensionGVMSBG
object
GB specific extension data for a goods movement record.
3 properties
ICRoutingCountryDTO
object
DTO to hold data for a routing country.
2 properties
ICCreateDeliveryResponseDTO
object
The response DTO after processing the request. Contains the resulting delivery information.
5 properties
ICGnssDTO
object
Global Navigation Satellite System data
2 properties
ICDeliveryExtensionDataDTO
object
DTO to hold delivery extension data for customs processes. Extension data is only required in some cases. Not all customs processes are supported.
33 properties
ICPreferentialDataEUDTO
object
DTO to hold data for preferential request (EU).
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 12
Other APIs AEB publishes across the network.
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
#InternationalCustomsBFBean
Where this information came from
This is an independent, third-party profile of AEB International Customs BF Bean 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.