Sending data to CAS
Sending data to CAS is mostly done by sending messages to the ingestion API. This will allow you to create new customs shipments, extend the master data etc.
Asynchronous processing
Messages are processed in the background asynchronously. This means that the response code for success indicates the acceptance for processing, not that all validations are successful.
Feedback like status changes (invalid, released, ...) are communicated through webhooks (for machines) or email alerts (for humans)
Availability
Highly available, even during maintenance windows. However, maintenance windows will still slow down the processing of messages sent to CAS.
Ingestion API endpoints
By using the following endpoints you can send data to CAS. These endpoints will execute some basic checks like the format & the structure of the data in real time, however the processing will be executed asynchronously.
- ArticleDataItem (xsd) Create or update articles in the master data
- BusinessPartners (xsd) Create or update business partners in the master data.
- CertificateOfOrigin (xsd) Request a certificate of origin based on a declaration
- CustomsShipment (xsd) Create a customs shipment to start a customs flow.
- Formula (xsd) Create a formula in master data that describes production of goods used by some special procedures
- MaterialList (xsd) Create a material list of products in the master data used by some special procedures
- MaterialListInvalidationRequest (xsd) Sometimes a material lists need to be invalidated
- MovementOrder (xsd) Used to create a movement order that will be processed in special procedure or tax warehouse stock management
Response
On success, all ingestion endpoints return 202 Accepted with a reference ID:
{
"referenceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
The referenceId uniquely identifies the ingested message. You can use it to find the ingestion in the ingestion history in the CAS user interface. It will also appear in creation and replace notification events (e.g. CreationUnsuccessful, ReplaceSuccessful) under the ingestionReferences field, allowing you to correlate the processing result back to the original message. Note that downstream events such as DeclarationStatusChanged do not include ingestionReferences; use the customsShipmentReference on those events to track declaration progress.
Error handling
For HTTP status codes and error response formats, see Error handling.
Business validation errors are communicated asynchronously through webhook notifications. Subscribe to the CustomsShipmentInformation / CreationUnsuccessful event to receive these errors. See Notifications for details.