Customs warehouse / bonded inventory management. Books goods receipts and issues against customs warehouse stock, tracks entries by MRN or ATLAS registration number, and reconciles inventory positions for the customs authority.
{
"openapi" : "3.0.1",
"info" : {
"title" : "Customs Inventory Management HTTP API",
"description" : "Thank you for using our HTTP API documentation.",
"version" : "1.0"
},
"servers" : [ {
"url" : "https://rz3.aeb.de/test2cim/rest"
} ],
"security" : [ {
"SWAGGER_AUTH_KEY" : [ ]
}, {
"BASIC_AUTH" : [ ]
} ],
"tags" : [ {
"name" : "Customs Inventory Management",
"description" : "REST endpoint for Customs Inventory Management"
}, {
"name" : "CoreBFBean",
"description" : "API for the XNSGFoundation"
}, {
"name" : "FoundationAFBean",
"description" : "Business facade for the XNSGFoundation UI API"
}, {
"name" : "Logon",
"description" : "Authentication handler for the XNSGFoundation"
}, {
"name" : "DataFeedBFBean",
"description" : "DataFeedBFBean"
}, {
"name" : "ExternalTelemetryBFBean",
"description" : "API for sending telemetry data from a third party system."
}, {
"name" : "FoundationBFBean",
"description" : "REST endpoint for FoundationBF"
}, {
"name" : "RemoteAdminBFBean",
"description" : " Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR)."
}, {
"name" : "SyncBFBean",
"description" : "API for synchronizing data asynchronous from an engine to a client system."
}, {
"name" : "Companies",
"description" : "Rest API for companies"
}, {
"name" : "WorkstationServiceAgent",
"description" : "Connection handler for the Workstation Service Agent"
} ],
"paths" : {
"/booking-requests/{id}/cancellation" : {
"post" : {
"tags" : [ "Customs Inventory Management" ],
"summary" : "Cancels a booking and the belonging booking request",
"description" : "Cancels a booking in the customs inventory management and marks the respective booking request as cancelled. If the booking request does not exist or is in a state in which no cancellation is allowed, an error message will be created and the cancellation will be stopped.",
"operationId" : "cancelBooking",
"parameters" : [ {
"name" : "client_ident_code",
"in" : "query",
"description" : "Client identification code.",
"required" : true,
"schema" : {
"maxLength" : 10,
"type" : "string"
},
"example" : "APITEST"
}, {
"name" : "id",
"in" : "path",
"description" : "Unique id to identify a booking request.",
"required" : true,
"schema" : {
"maxLength" : 64,
"type" : "string"
}
}, {
"name" : "cancellation_reason",
"in" : "query",
"description" : "Free-form text that documents the reason for the cancellation.",
"required" : true,
"schema" : {
"maxLength" : 1000,
"type" : "string"
},
"example" : "Delivery item 123 was incorrectly labeled as customs warehouse item."
} ],
"responses" : {
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token."
},
"405" : {
"description" : "Method not allowed."
},
"406" : {
"description" : "Not Acceptable."
},
"415" : {
"description" : "Unsupported Media Type. Use application/json"
},
"500" : {
"description" : "Other errors like an internal server error. See response for details.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"200" : {
"description" : "OK. The cancelled booking request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMBookingRequestsResponseDTO"
}
}
}
},
"400" : {
"description" : "Bad request. Missing or invalid data in the request body.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"404" : {
"description" : "Not found. Booking request does not exist.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"409" : {
"description" : "Conflict. The booking request with the id is locked or does not allow the cancellation.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
}
}
}
},
"/booking-requests/{id}" : {
"get" : {
"tags" : [ "Customs Inventory Management" ],
"summary" : "Retrieves a booking request",
"description" : "Rretrieves a booking request with the requested business object id.",
"operationId" : "getBookingRequest",
"parameters" : [ {
"name" : "client_ident_code",
"in" : "query",
"description" : "Client identification code.",
"required" : true,
"schema" : {
"maxLength" : 10,
"type" : "string"
},
"example" : "APITEST"
}, {
"name" : "id",
"in" : "path",
"description" : "Unique id to identify a booking request.",
"required" : true,
"schema" : {
"maxLength" : 64,
"type" : "string"
}
} ],
"responses" : {
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token."
},
"405" : {
"description" : "Method not allowed."
},
"406" : {
"description" : "Not Acceptable."
},
"415" : {
"description" : "Unsupported Media Type. Use application/json"
},
"500" : {
"description" : "Other errors like an internal server error. See response for details.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"200" : {
"description" : "OK. The requested booking request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMBookingRequestsResponseDTO"
}
}
}
},
"400" : {
"description" : "Bad request. Missing or invalid data in the request body.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"404" : {
"description" : "Not found. Booking request does not exist.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
}
}
},
"post" : {
"tags" : [ "Customs Inventory Management" ],
"summary" : "Creates a booking request",
"description" : "Creates a booking request in order to request a booking from and/or to customs inventory management systems and to trigger the belonging customs declarations, if necessary. If any fields of the booking request are empty which are mandatory, an error message will be created and the creation stopped. Only if the mandatory fields are filled the booking request will be created.",
"operationId" : "createBookingRequestREST",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Unique id to identify a booking request.",
"required" : true,
"schema" : {
"maxLength" : 64,
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The booking request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMCreateBookingRequestRequestDTO"
},
"examples" : {
"Minimal example" : {
"description" : "Example with a minimum set of required fields.",
"value" : {
"clientIdentCode" : "APITEST",
"bookingRequest" : {
"profileCode" : "STD",
"type" : "CUSTOMS_WAREHOUSE_TO_FREE_CIRCULATION",
"material" : {
"materialId" : "M-1000"
},
"quantity" : {
"value" : "10",
"uneceUnit" : "NAR"
},
"decisiveDate" : {
"dateInTimezone" : "1970-01-01 00:00:00",
"timezone" : "UTC"
}
}
}
},
"Full example" : {
"description" : "Example with all fields filled (except additional declaration data).",
"value" : {
"clientIdentCode" : "APITEST",
"userName" : "API_TEST",
"resultLanguageIsoCodes" : [ "en" ],
"bookingRequest" : {
"referenceNumber" : "BR-1000",
"referenceEntry" : {
"registrationNumber" : "25DE-1000",
"sequenceNumber" : "11111"
},
"remark" : "Remark",
"profileCode" : "STD",
"personInCharge" : {
"forename" : "Jane",
"surname" : "Doe",
"initials" : "JD"
},
"type" : "CUSTOMS_WAREHOUSE_TO_FREE_CIRCULATION",
"identitiesRemoval" : [ "REMOVAL-ID-1000" ],
"identitiesEntry" : [ "ENTRY-ID-1000" ],
"decisiveDate" : {
"dateInTimezone" : "1970-01-01 00:00:00",
"timezone" : "UTC"
},
"material" : {
"materialId" : "M-1000"
},
"quantity" : {
"value" : "10",
"uneceUnit" : "NAR"
}
}
}
},
"Full example (with add. declaration data)" : {
"description" : "Example with all fields filled.",
"value" : {
"clientIdentCode" : "APITEST",
"userName" : "API_TEST",
"resultLanguageIsoCodes" : [ "en" ],
"bookingRequest" : {
"referenceNumber" : "BR-1000",
"referenceEntry" : {
"registrationNumber" : "25DE-1000",
"sequenceNumber" : "11111"
},
"remark" : "Remark",
"profileCode" : "STD",
"personInCharge" : {
"forename" : "Jane",
"surname" : "Doe",
"initials" : "JD"
},
"type" : "CUSTOMS_WAREHOUSE_TO_FREE_CIRCULATION",
"identitiesRemoval" : [ "REMOVAL-ID-1000" ],
"identitiesEntry" : [ "ENTRY-ID-1000" ],
"decisiveDate" : {
"dateInTimezone" : "1970-01-01 00:00:00",
"timezone" : "UTC"
},
"material" : {
"materialId" : "M-1000"
},
"quantity" : {
"value" : "10",
"uneceUnit" : "NAR"
},
"additionalDeclarationData" : {
"transactionNature" : "11",
"netPrice" : {
"value" : "10",
"currencyIsoCode" : "EUR"
},
"netMass" : {
"value" : "10",
"uneceUnit" : "KGM"
},
"grossMass" : {
"value" : "15",
"uneceUnit" : "KGM"
},
"additionalQuantities" : [ {
"value" : "1",
"unit" : "MTK"
} ],
"packages" : [ {
"numberOfPackages" : "10",
"typeUneceCode" : "CS",
"marksAndNumbers" : "Marks"
} ],
"originCountryCode" : "CN",
"preferentialOriginCountryCode" : "CN"
}
}
}
}
}
}
},
"required" : true
},
"responses" : {
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token."
},
"405" : {
"description" : "Method not allowed."
},
"406" : {
"description" : "Not Acceptable."
},
"415" : {
"description" : "Unsupported Media Type. Use application/json"
},
"500" : {
"description" : "Other errors like an internal server error. See response for details.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"200" : {
"description" : "OK. The created booking request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMBookingRequestsResponseDTO"
}
}
}
},
"400" : {
"description" : "Bad request. Missing or invalid data in the request body.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"409" : {
"description" : "Conflict. A booking request with the id already exists.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Customs Inventory Management" ],
"summary" : "Deletes a booking request",
"description" : "Deletes a booking request. If the booking request does not exist or is in a state in which no deletion is allowed, an error message will be created and the deletion will be stopped.",
"operationId" : "deleteBookingRequest",
"parameters" : [ {
"name" : "client_ident_code",
"in" : "query",
"description" : "Client identification code.",
"required" : true,
"schema" : {
"maxLength" : 10,
"type" : "string"
},
"example" : "APITEST"
}, {
"name" : "id",
"in" : "path",
"description" : "Unique id to identify a booking request.",
"required" : true,
"schema" : {
"maxLength" : 64,
"type" : "string"
}
} ],
"responses" : {
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token."
},
"405" : {
"description" : "Method not allowed."
},
"406" : {
"description" : "Not Acceptable."
},
"415" : {
"description" : "Unsupported Media Type. Use application/json"
},
"500" : {
"description" : "Other errors like an internal server error. See response for details.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"200" : {
"description" : "OK. The updated/created booking request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMBookingRequestsResponseDTO"
}
}
}
},
"400" : {
"description" : "Bad request. Missing or invalid data in the request body.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"404" : {
"description" : "Not found. Booking request does not exist.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"409" : {
"description" : "Conflict. The booking request with the ids is locked or does not allow deletion any longer.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
}
}
}
},
"/booking-request-types" : {
"get" : {
"tags" : [ "Customs Inventory Management" ],
"summary" : "Retrieves supported booking request types",
"description" : "Returns a list of supported codes and its descriptions which can be used as booking request type.",
"operationId" : "getBookingRequestTypes",
"parameters" : [ {
"name" : "client_ident_code",
"in" : "query",
"description" : "Client identification code.",
"required" : true,
"schema" : {
"maxLength" : 10,
"type" : "string"
},
"example" : "APITEST"
}, {
"name" : "result_language_iso_code",
"in" : "query",
"description" : "2-letter ISO code of the language in which texts will be returned. ",
"schema" : {
"maxLength" : 2,
"type" : "string"
},
"example" : "en"
} ],
"responses" : {
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token."
},
"405" : {
"description" : "Method not allowed."
},
"406" : {
"description" : "Not Acceptable."
},
"415" : {
"description" : "Unsupported Media Type. Use application/json"
},
"500" : {
"description" : "Other errors like an internal server error. See response for details.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"200" : {
"description" : "OK. The supported booking request type codes and its descriptions.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMGetBookingRequestTypesResponseDTO"
}
}
}
}
}
}
},
"/inventories/{inventory-key}/stock-accounts/balances" : {
"get" : {
"tags" : [ "Customs Inventory Management" ],
"summary" : "Retrieves stock account balances",
"description" : "Returns the stock account balances for the requested inventory.",
"operationId" : "getStockAccountBalances",
"parameters" : [ {
"name" : "inventory-key",
"in" : "path",
"description" : "Key of the target inventory.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "client_ident_code",
"in" : "query",
"description" : "Client identification code.",
"required" : true,
"schema" : {
"maxLength" : 10,
"type" : "string"
},
"example" : "APITEST"
}, {
"name" : "stock_account_keys",
"in" : "query",
"description" : "<p>List with keys of stock accounts for which stock account balances will be returned.</p><p>If the list is empty, stock balances with zero quantity are not returned, these are returned only for the requested stock accounts.</p><p>Maximum number of keys = 99. Empty and repeated keys are not allowed.</p>",
"schema" : {
"maxItems" : 99,
"uniqueItems" : true,
"type" : "array",
"items" : {
"minLength" : 1,
"type" : "string"
}
}
}, {
"name" : "group_by_identities",
"in" : "query",
"description" : "True if the result is to be grouped by identities - Default is false.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"401" : {
"description" : "Unauthorized. Missing or invalid authorization token."
},
"405" : {
"description" : "Method not allowed."
},
"406" : {
"description" : "Not Acceptable."
},
"415" : {
"description" : "Unsupported Media Type. Use application/json"
},
"500" : {
"description" : "Other errors like an internal server error. See response for details.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
},
"200" : {
"description" : "OK. Stock account balances inquiry result data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CIMStockAccountBalancesResponseDTO"
}
}
}
},
"404" : {
"description" : "Not found. Stock does not exist.",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDTO"
}
}
}
}
}
}
},
"/CoreBFBean/checkBFFunctionExists" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Can be called to know if a BF function exist.",
"operationId" : "checkBFFunctionExists",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BFFunctionDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BFFunctionExistsDTO"
}
}
}
}
}
}
},
"/CoreBFBean/echo" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns the given echo parameter value.",
"operationId" : "echo",
"parameters" : [ {
"name" : "echo",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/echoUpperCase" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns the given echo parameter value in uppercase.",
"operationId" : "echoUpperCase",
"parameters" : [ {
"name" : "echo",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getAllMonitoringValues" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns all available monitoring values of the server.",
"operationId" : "getAllMonitoringValues",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MonitoringDataProviderDTO"
}
}
}
}
}
}
}
},
"/CoreBFBean/getBuildForSolution" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \\\"/AEB/XNSG_IF_BLDSOL\\\".",
"operationId" : "getBuildForSolution",
"parameters" : [ {
"name" : "solutionName",
"in" : "query",
"description" : "solutionName the name of the solution for which version information is to be obtained",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getMonitoringValue" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Returns the current monitoring value for the given group and name.",
"operationId" : "getMonitoringValue",
"parameters" : [ {
"name" : "groupName",
"in" : "query",
"schema" : {
"type" : "string"
}
}, {
"name" : "valueName",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getProductInfo" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is \\\"/AEB/XNSG_IF_PRINFO\\\".",
"operationId" : "getProductInfo",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductInfoDTO"
}
}
}
}
}
}
},
"/CoreBFBean/getRuntimeInfo" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is \\\"/AEB/XNSG_IF_RTINFO\\\".",
"operationId" : "getRuntimeInfo",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeInfoDTO"
}
}
}
}
}
}
},
"/CoreBFBean/getRuntimeState" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return runtime state information about the server that is answering this request. This includes if the server is doing fine or not. Also included are the supported operations (bfs) for the installation repository The RFC name of this function is \\\"/AEB/XNSG_IF_RTSTATE\\\".",
"operationId" : "getRuntimeState",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeStateParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeStateResultDTO"
}
}
}
}
}
}
},
"/CoreBFBean/getThreadDump" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Generate Thread-Dump.",
"operationId" : "getThreadDump",
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/CoreBFBean/getVersionForSolution" : {
"get" : {
"tags" : [ "CoreBFBean" ],
"description" : "Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \\\"/AEB/XNSG_IF_VERSOL\\\".",
"operationId" : "getVersionForSolution",
"parameters" : [ {
"name" : "solutionName",
"in" : "query",
"description" : "solutionName the name of the solution for which version information is to be obtained",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VersionInfoDTO"
}
}
}
}
}
}
},
"/CoreBFBean/restartRFCServer" : {
"post" : {
"tags" : [ "CoreBFBean" ],
"description" : "This method is only usefull to
# --- truncated at 32 KB (260 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-customs-inventory-management-openapi.json